Skip to content
This repository has been archived by the owner on Nov 17, 2023. It is now read-only.

CNVGR-2 Create the README.md for app set up #4

Open
ReneCapella opened this issue Aug 20, 2021 · 0 comments · Fixed by #13
Open

CNVGR-2 Create the README.md for app set up #4

ReneCapella opened this issue Aug 20, 2021 · 0 comments · Fixed by #13
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Milestone

Comments

@ReneCapella
Copy link
Contributor

Please include technical writing design: white space, headlines, bullet points: to help readability.

Also consider equitable design: ie, can we present the data for populations normally not considered? Vision impairment might benefit from an audio file, Neurodivergency might benefit from a Video or images.

Document should explain how to set up the application from Mac, Linux, or Windows. Explanations should include code snippets if commands need to be entered.

Troubleshooting section is great.

@ReneCapella ReneCapella added documentation Improvements or additions to documentation good first issue Good for newcomers labels Aug 20, 2021
@ReneCapella ReneCapella added this to the MVP milestone Aug 20, 2021
@KristinJJ KristinJJ self-assigned this Oct 20, 2021
@KristinJJ KristinJJ linked a pull request Oct 24, 2021 that will close this issue
This was referenced Nov 6, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants