Gitiles
Code Review Sign In
gerrit.named-data.net / ndn-tools / 96412a18d84997978a853417e87b16838fd42f2a / . / README.md
blob: 94dabe6064a3f4621f5378cddd8ee8b1fcd50b7b [file] [log] [blame] [view]
Junxiao Shi6ca48812015-03-26 23:14:19 -0700[diff] [blame]1# NDN Essential Tools
2
Davide Pesaventoc4343232021-08-13 23:17:05 -0400[diff] [blame]3[![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)
4[![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 Pesaventob3570c62022-02-19 19:19:00 -0500[diff] [blame]5![Language](https://img.shields.io/badge/C%2B%2B-17-blue)
Davide Pesaventoc4343232021-08-13 23:17:05 -0400[diff] [blame]6![Latest version](https://img.shields.io/github/v/tag/named-data/ndn-tools?label=Latest%20version)
Davide Pesaventob5a57452016-09-20 19:18:25 +0200[diff] [blame]7
Davide Pesavento786a7f22019-04-14 17:18:14 -0400[diff] [blame]8**ndn-tools** is a collection of basic tools for [Named Data Networking](https://named-data.net/).
Junxiao Shi6ca48812015-03-26 23:14:19 -0700[diff] [blame]9Tools in this collection include:
10
Davide Pesavento786a7f22019-04-14 17:18:14 -0400[diff] [blame]11* [peek](tools/peek): transmit a single Interest/Data packet between a consumer
12 and a producer
13* [chunks](tools/chunks): segmented file transfer between a consumer and a producer
14* [ping](tools/ping): test reachability between two NDN nodes
15* [dump](tools/dump): capture and analyze live traffic on an NDN network
16* [dissect](tools/dissect): inspect the TLV structure of an NDN packet
17* [dissect-wireshark](tools/dissect-wireshark): Wireshark extension to inspect
18 the TLV structure of NDN packets
Junxiao Shi6ca48812015-03-26 23:14:19 -0700[diff] [blame]19
Davide Pesavento786a7f22019-04-14 17:18:14 -0400[diff] [blame]20## Installation
Junxiao Shi6ca48812015-03-26 23:14:19 -0700[diff] [blame]21
Davide Pesavento786a7f22019-04-14 17:18:14 -0400[diff] [blame]22See [`INSTALL.md`](INSTALL.md) for build instructions.
23
24## Reporting bugs
25
26Please submit any bug reports or feature requests to the
27[ndn-tools issue tracker](https://redmine.named-data.net/projects/ndn-tools/issues).
28
29## Contributing
30
Davide Pesaventob07d7a92020-05-13 23:30:07 -0400[diff] [blame]31We greatly appreciate contributions to ndn-tools. If you are new to the NDN
Davide Pesavento786a7f22019-04-14 17:18:14 -0400[diff] [blame]32software community, please read [`README-dev.md`](README-dev.md) and the
Davide Pesaventob07d7a92020-05-13 23:30:07 -0400[diff] [blame]33[Contributor's Guide](https://github.com/named-data/.github/blob/master/CONTRIBUTING.md)
Davide Pesavento786a7f22019-04-14 17:18:14 -0400[diff] [blame]34to get started.
35
36## License
37
38ndn-tools is an open source project licensed under the GPL version 3.
39See [`COPYING.md`](COPYING.md) for more information.