Task #2673
closed
Write README
100%
Description
Add top-level README and related documentation:
- README.md introduces what is ndn-tools
- INSTALL.md describes how to build and install ndn-tools
- README-dev.md explains the structure of codebase, and how to develop a new tool
- AUTHORS.md lists authors
Updated by Junxiao Shi over 9 years ago
- Status changed from New to In Progress
- Estimated time set to 1.50 h
Updated by Junxiao Shi over 9 years ago
- % Done changed from 0 to 50
http://gerrit.named-data.net/1907 has the initial user-facing docs.
Developer-facing docs 'README-dev.md' will come in another commit.
Updated by Junxiao Shi over 9 years ago
- Description updated (diff)
- % Done changed from 50 to 90
http://gerrit.named-data.net/1949 has initial developer-facing docs.
Next commit will add the author list 'AUTHORS.md'.
Updated by Junxiao Shi over 9 years ago
An example snippet in commit:f6351f5de29ef68629a3fb15f8fea1f085ec480f is missing a bracket. This is fixed in http://gerrit.named-data.net/1968.
Updated by Junxiao Shi over 9 years ago
- Status changed from In Progress to Code review
- % Done changed from 90 to 100
AUTHORS.md is added in http://gerrit.named-data.net/1998.
I put only myself in "primary authors" for now, because all commits to ndn-tools are from my account.
Those who have contributed to ndn-tlv-peek ndn-tlv-poke ndn-tlv-ping before they are imported are listed under contributors.
Updated by Junxiao Shi over 9 years ago
Alex's comment:
given historically, this project is actually a combination of multiple sub-projects, I would not define a concept of primary author. I would just define authors (contributors) and per-module (including overall project module) maintainer.
Yes, but I'd keep it simple and just define contributors.
Updated by Junxiao Shi over 9 years ago
- Status changed from Code review to Closed