Uploaded image for project: 'Social Justice Repair Kit'
  1. Social Justice Repair Kit
  2. SJRK-377

Break README into smaller files

    XMLWordPrintable

    Details

      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.

        Attachments

          Activity

            People

            Assignee:
            Unassigned Unassigned
            Reporter:
            gmoss Gregor Moss
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

              Dates

              Created:
              Updated: