Update Documentation
Closed this issue · 0 comments
bliutech commented
Updated documentation to ensure the repository looks professional.
To Do:
- create a
README.md
- add brief description about the project (i.e. research project at NJ GSET 2022) & add it to the GitHub description (located on right hand side near settings wheel)
- add list of technologies & dependencies
- add essential links (i.e. link to paper maybe link to symposium recording)
- describe how someone could replicate your project (i.e. describe how to clone and where all the necessary files are)
- include the names of all authors