search

nfc-tools / nfc-tools.github.io

nfc-tools' web site
http://nfc-tools.github.io
16 stars 13 forks source link

Migrate project pages #1

Open smortex opened 9 years ago

smortex commented 9 years ago

Currently, the nfc-tools wiki has pages for each project, containing various information about obtaining, building, using and debugging the software. Some of these instructions are also present in the project repository (e.g. build instructions) and the duplicated information trend to be inaccurate (nfc-tools/libnfc#294).

Because GitHub's README.md is an ubiquitous primary source of information for most hackers (those I know at least), it makes sense to have the build instructions of each project in it's README.md file, and removed them from other places.

The nfc-tools website page for each project can become an "advertising" page highlighting key features of the project and linking to the GitHub repository.

Pages about "advanced" hacking (e.g. with patches, that is pages which contain code that can be broken in the future with the evolution of the tools) need to be timestamped and can therefore be moved in some kind of blog.

Finally, general information can be linked from each project's README.md regarding:

Any though are welcome !

ozett commented 9 years ago

everthing you mention sounds reasonable. there must be other projects which sucessfully do so.