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.

Sign up for GitHub

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

Jump to bottom

Document Getting started in README.md #24

Open
dameyerdave opened this issue Feb 16, 2023 · 1 comment
Open

Document Getting started in README.md #24

dameyerdave opened this issue Feb 16, 2023 · 1 comment
Assignees
@anastasia-escher
Labels
prio 2

Comments

@dameyerdave
Copy link
Contributor

Documentation is important. We should always add at least everything that is needed to get started with an application to the README.md file. Probably we could use this README.md file as a template for other projects. At least the structure.
I suggest to have a look into other projects (well known public projects) and derive a structure from there.

Essential to the documentation in the README.md is that a new user can setup the application and use it afterwards. That means that not all details need to be in the README.md - they should me in a real documentation (i.e. mkdocs).
@dameyerdave
Copy link
Contributor Author

I leave this one open, because it make sense to document every new feature that is important for getting started.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@anastasia-escher anastasia-escher

Labels
prio 2
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@dameyerdave @anastasia-escher