Details
-
Type:
Improvement
-
Status: Open
-
Priority:
Major
-
Resolution: Unresolved
-
Affects Version/s: None
-
Fix Version/s: None
-
Component/s: Storytelling Tool Server, Storytelling Tool UI
-
Labels:None
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.