Skip to content
This repository has been archived by the owner on Apr 22, 2021. It is now read-only.

documentation #102

Open
jpetto opened this issue Dec 10, 2020 · 2 comments
Open

documentation #102

jpetto opened this issue Dec 10, 2020 · 2 comments

Comments

@jpetto
Copy link

jpetto commented Dec 10, 2020

we should create (and maintain!) documentation on how to run the application locally. additional points may be architectural decisions and how the application should be maintained.

this should be lower priority than other issues.

@Nitaiz123
Copy link

Great Idea jpetto

@nina-py
Copy link
Contributor

nina-py commented Mar 19, 2021

Just adding a note here that this issue should be resolved when the README contains the following:

  • an overview of the application, perhaps with a screenshot;
  • an explanation of architectural decisions made while the app was under active development;
  • instructions on how to set up this project locally (Update setup documentation #124).

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants