Gitiles
Code Review Sign In
gerrit.named-data.net / ndn-tools / 5748e82c1ea2324c664fe97d2b2912e956f9fe8b / . / README.md
blob: 54a66c5ee3cdfe9d9a68ccac6c65bca440f662c4 [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 Pesaventodb9613e2023-01-20 20:52:21 -0500[diff] [blame]8This repository contains a collection of basic tools for [Named Data Networking (NDN)](https://named-data.net/).
9The tools currently included are:
Junxiao Shi6ca48812015-03-26 23:14:19 -0700[diff] [blame]10
Davide Pesaventodb9613e2023-01-20 20:52:21 -0500[diff] [blame]11* [**peek**](tools/peek): transmit a single Interest/Data packet between a consumer
Davide Pesavento786a7f22019-04-14 17:18:14 -0400[diff] [blame]12 and a producer
Davide Pesaventodb9613e2023-01-20 20:52:21 -0500[diff] [blame]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
Davide Pesavento786a7f22019-04-14 17:18:14 -0400[diff] [blame]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 Pesaventodb9613e2023-01-20 20:52:21 -0500[diff] [blame]31Contributions to ndn-tools are greatly appreciated and can be made through our
32[Gerrit code review site](https://gerrit.named-data.net/).
33If you are new to the NDN software community, please read our
34[Contributor's Guide](https://github.com/named-data/.github/blob/main/CONTRIBUTING.md)
35and [`README-dev.md`](README-dev.md) to get started.
Davide Pesavento786a7f22019-04-14 17:18:14 -0400[diff] [blame]36
37## License
38
Davide Pesaventodb9613e2023-01-20 20:52:21 -0500[diff] [blame]39ndn-tools is free software distributed under the GNU General Public License version 3.
40See [`COPYING.md`](COPYING.md) for details.