Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate project pages #1

Open
smortex opened this issue May 13, 2015 · 1 comment
Open

Migrate project pages #1

smortex opened this issue May 13, 2015 · 1 comment
Assignees
Labels

Comments

@smortex
Copy link
Contributor

smortex commented May 13, 2015

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 !

@smortex smortex self-assigned this May 13, 2015
@smortex smortex added this to the nfc-tools reloaded milestone May 13, 2015
@ozett
Copy link

ozett commented May 13, 2015

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants