documentation - Githubissues

Pocket / curation-tools-frontend

DEPRECATED

Mozilla Public License 2.0

10 stars 52 forks source link

documentation #102

Open jpetto opened 3 years ago

jpetto commented 3 years ago

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 commented 3 years ago

Great Idea jpetto

nina-py commented 3 years ago

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 (#124).