search

pzavros / Inspire-MobileApp

1 stars 0 forks source link

Recommendations for README.md & logging #2

Open nkasenides opened 1 year ago

nkasenides commented 1 year ago

Please consider adding some more information to your README.md file such as:

  1. Add the role of each member of your team next to your names. If you are all working on development but have different areas of responsibility, you can add those there. It would be useful to understand who is working on what.
  2. Create a second file called VERSION.md and link it to README.md. In this file, add very brief descriptions for each of the features you have worked on (as a team) during the last sprint/timeframe (e.g. new features, improvements, bug-fixes, etc.)
  3. You could also consider adding some screenshots. You can save and upload screenshots in a separate folder (i.e., screenshots) on GitHub. This can also include wireframes and may help you communicate with the client more effectively.
  4. Include the final deadline of the project, and timeframes for major milestones/deliverables.
  5. Instructions on how to install and run the project, along any software that is needed to run it.
  6. As your repository is public, also consider adding a license to it. GNU GPL is preferable.