Gitiles
Code Review Sign In
gerrit.named-data.net / ndn-tools / a48c3ad1c9f762a0574be369602602dca84a2254 / . / README.md
blob: ae8c62a88baaa2445fe2b2837e3db0f83162030c [file] [log] [blame] [view]
Junxiao Shi6ca48812015-03-26 23:14:19 -0700[diff] [blame]1# NDN Essential Tools
2
Davide Pesaventocc02c362024-04-21 16:45:05 -0400[diff] [blame]3![Latest version](https://img.shields.io/github/v/tag/named-data/ndn-tools?label=Latest%20version)
4![Language](https://img.shields.io/badge/C%2B%2B-17-blue)
Davide Pesaventoc4343232021-08-13 23:17:05 -0400[diff] [blame]5[![CI](https://github.com/named-data/ndn-tools/actions/workflows/ci.yml/badge.svg)](https://github.com/named-data/ndn-tools/actions/workflows/ci.yml)
Davide Pesavento81c3c642024-05-08 13:40:47 -0400[diff] [blame]6[![Docker](https://github.com/named-data/ndn-tools/actions/workflows/docker.yml/badge.svg)](https://github.com/named-data/ndn-tools/actions/workflows/docker.yml)
Davide Pesaventoc4343232021-08-13 23:17:05 -0400[diff] [blame]7[![Docs](https://github.com/named-data/ndn-tools/actions/workflows/docs.yml/badge.svg)](https://github.com/named-data/ndn-tools/actions/workflows/docs.yml)
Davide Pesaventob5a57452016-09-20 19:18:25 +0200[diff] [blame]8
Davide Pesaventodb9613e2023-01-20 20:52:21 -0500[diff] [blame]9This repository contains a collection of basic tools for [Named Data Networking (NDN)](https://named-data.net/).
10The tools currently included are:
Junxiao Shi6ca48812015-03-26 23:14:19 -0700[diff] [blame]11
Davide Pesaventodb9613e2023-01-20 20:52:21 -0500[diff] [blame]12* [**peek**](tools/peek): transmit a single Interest/Data packet between a consumer
Davide Pesavento786a7f22019-04-14 17:18:14 -0400[diff] [blame]13 and a producer
Davide Pesaventodb9613e2023-01-20 20:52:21 -0500[diff] [blame]14* [**chunks**](tools/chunks): segmented file transfer between a consumer and a producer
15* [**ping**](tools/ping): test reachability between two NDN nodes
16* [**dump**](tools/dump): capture and analyze live traffic on an NDN network
17* [**dissect**](tools/dissect): inspect the TLV structure of an NDN packet
18* [**dissect-wireshark**](tools/dissect-wireshark): Wireshark extension to inspect
Davide Pesavento786a7f22019-04-14 17:18:14 -0400[diff] [blame]19 the TLV structure of NDN packets
Junxiao Shi6ca48812015-03-26 23:14:19 -0700[diff] [blame]20
Davide Pesavento786a7f22019-04-14 17:18:14 -0400[diff] [blame]21## Installation
Junxiao Shi6ca48812015-03-26 23:14:19 -0700[diff] [blame]22
Davide Pesavento786a7f22019-04-14 17:18:14 -0400[diff] [blame]23See [`INSTALL.md`](INSTALL.md) for build instructions.
24
25## Reporting bugs
26
27Please submit any bug reports or feature requests to the
28[ndn-tools issue tracker](https://redmine.named-data.net/projects/ndn-tools/issues).
29
30## Contributing
31
Davide Pesaventodb9613e2023-01-20 20:52:21 -0500[diff] [blame]32Contributions to ndn-tools are greatly appreciated and can be made through our
33[Gerrit code review site](https://gerrit.named-data.net/).
34If you are new to the NDN software community, please read our
35[Contributor's Guide](https://github.com/named-data/.github/blob/main/CONTRIBUTING.md)
36and [`README-dev.md`](README-dev.md) to get started.
Davide Pesavento786a7f22019-04-14 17:18:14 -0400[diff] [blame]37
38## License
39
Davide Pesaventodb9613e2023-01-20 20:52:21 -0500[diff] [blame]40ndn-tools is free software distributed under the GNU General Public License version 3.
41See [`COPYING.md`](COPYING.md) for details.