Metadata
- Source
- SJRK-377
- Type
- Improvement
- Priority
- Major
- Status
- Open
- Resolution
- N/A
- Assignee
- N/A
- Reporter
- Gregor Moss
- Created
2020-07-14T01:56:33.565-0400 - Updated
2020-07-14T02:00:20.463-0400 - Versions
- N/A
- Fixed Versions
- N/A
- Component
-
- Storytelling Tool Server
- Storytelling Tool UI
Description
The current README.md for the Storytelling Tool repo is very long and difficult to navigate. This is a combination of both the amount of content in the file as well as the formatting of it.
The following should be addressed:
- Examine README files for other large projects on GitHub for some good methods
- Keep only basic info in the README and provide an organized list of links to the other files in the "docs" directory
- Improve the formatting for best readability
- Add any applicable badges such as Licence, Docker build passing/failing, etc.