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

We need better documentation #21

Open
mofosyne opened this issue Aug 29, 2015 · 2 comments
Open

We need better documentation #21

mofosyne opened this issue Aug 29, 2015 · 2 comments
Labels

Comments

@mofosyne
Copy link
Contributor

Both Tagdrop and Qrstream needs better documentation. There was bunch of things you mention, that I didn't realize I could do. Also didn't know volume button can adjust qr sequence etc...

This could probbly be written within the readme, and having the app point a link to the readme page. (By the way, I'm surprised you are not using readme.md markdown).

@xloem xloem added the bug label Aug 29, 2015
@mofosyne
Copy link
Contributor Author

https://github.com/mofosyne/instantReadmeApp/

This could help, in keeping the readme in app synced to the project readme

@xloem
Copy link
Owner

xloem commented Nov 28, 2015

  1. Document any new features as they are created
  2. Create well-designed, complete user in interface (for example deal with Allow the user to choose the filename saved to #12) Document any new features as they are created well enough for them to be used.
  3. Create complete documentation after there is a complete UI. Copy system used by any random popular application.

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