| Junxiao Shi | 6ca4881 | 2015-03-26 23:14:19 -0700 | [diff] [blame] | 1 | # NDN Essential Tools |
| 2 | |
| Davide Pesavento | 786a7f2 | 2019-04-14 17:18:14 -0400 | [diff] [blame^] | 3 |  |
| Davide Pesavento | b5a5745 | 2016-09-20 19:18:25 +0200 | [diff] [blame] | 4 | [](https://travis-ci.org/named-data/ndn-tools) |
| Davide Pesavento | 786a7f2 | 2019-04-14 17:18:14 -0400 | [diff] [blame^] | 5 |  |
| Davide Pesavento | b5a5745 | 2016-09-20 19:18:25 +0200 | [diff] [blame] | 6 | |
| Davide Pesavento | 786a7f2 | 2019-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 Shi | 6ca4881 | 2015-03-26 23:14:19 -0700 | [diff] [blame] | 8 | Tools in this collection include: |
| 9 | |
| Davide Pesavento | 786a7f2 | 2019-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 Shi | 6ca4881 | 2015-03-26 23:14:19 -0700 | [diff] [blame] | 18 | |
| Davide Pesavento | 786a7f2 | 2019-04-14 17:18:14 -0400 | [diff] [blame^] | 19 | ## Installation |
| Junxiao Shi | 6ca4881 | 2015-03-26 23:14:19 -0700 | [diff] [blame] | 20 | |
| Davide Pesavento | 786a7f2 | 2019-04-14 17:18:14 -0400 | [diff] [blame^] | 21 | See [`INSTALL.md`](INSTALL.md) for build instructions. |
| 22 | |
| 23 | ## Reporting bugs |
| 24 | |
| 25 | Please 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 | |
| 30 | You're encouraged to contribute to ndn-tools! If you are new to the NDN |
| 31 | software community, please read [`README-dev.md`](README-dev.md) and the |
| 32 | [Contributor's Guide](https://github.com/named-data/NFD/blob/master/CONTRIBUTING.md) |
| 33 | to get started. |
| 34 | |
| 35 | ## License |
| 36 | |
| 37 | ndn-tools is an open source project licensed under the GPL version 3. |
| 38 | See [`COPYING.md`](COPYING.md) for more information. |