Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🐾 Minor Update: Documentation #51

Closed
4 of 5 tasks
bliutech opened this issue Jul 22, 2023 · 0 comments · Fixed by #53
Closed
4 of 5 tasks

🐾 Minor Update: Documentation #51

bliutech opened this issue Jul 22, 2023 · 0 comments · Fixed by #53
Labels
documentation Improvements or additions to documentation

Comments

@bliutech
Copy link
Owner

bliutech commented Jul 22, 2023

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 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! 😄

References:


This is a 🐾 Minor Update

@bliutech bliutech added the documentation Improvements or additions to documentation label Jul 22, 2023
@bliutech bliutech linked a pull request Jul 26, 2023 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant