nfc-tools / nfc-tools.github.io Goto Github PK

The nfc-tools wiki has a number of informational pages that are not that easy to find with the current flat layout and would benefit from a move to Jekyll with a hierarchical organization.

• Documentation
  • Chips
    • PN51x
    • PN53x
  • Initiators
    • ACR122
    • Arygon
    • OpenPCD 2
    • RC-S360
    • RDR608
    • SCL3711
    • StickID
  • Targets
    • FeliCa
    • Innovatron
    • Jewel/Topaz
    • MIFARE Classic
    • MIFARE DESFire
    • MIFARE DESFire EV1
    • MIFARE Plus
    • MIFARE Ultralight
    • MIFARE Ultralight C
  • Standards
    • ISO14443
    • ISO14443A
    • ISO14443B
    • ISO14443B'
    • ISO15693

Open questions:

• Documentation (root element) is probably not the right name. Any better idea?
• How to name / group initiators ?
• Separating Targets / Standards is maybe not a good idea ?
• Any point you would like to see discussed ?

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:

• Debugging
• Reporting bugs
• Support

Any though are welcome !

We currently not provide versioning information for all nfc-tools projects (see nfc-tools/libfreefare#46).

I feel like the Semantic Versioning Specification is the way to go as it's already almost what we try to do. Any objection?