You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The final task of every software project is to ensure that there remains excellent documentation for future developers to try and interact with your code or understand your project. The goal here is to update README.md with relevant information about our project and to ensure that access to relevant links is available. Below are a few other READMEs to reference for looking for what to add.
Make sure to include:
paper abstract
authors
how to run the application locally / install relevant dependencies and frameworks
photo from the paper or application (shows a rough overview of how the application works)
star the repo! Helps show some love for your own project! 😄
Use Case
The final task of every software project is to ensure that there remains excellent documentation for future developers to try and interact with your code or understand your project. The goal here is to update
README.md
with relevant information about our project and to ensure that access to relevant links is available. Below are a few otherREADME
s to reference for looking for what to add.Make sure to include:
References:
This is a 🐾 Minor Update
The text was updated successfully, but these errors were encountered: