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