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.

Sign up for GitHub

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

Jump to bottom

Documentation Tasks #1

Open
3 of 7 tasks
pganguli opened this issue Nov 12, 2023 · 0 comments
Open
3 of 7 tasks

Documentation Tasks #1

pganguli opened this issue Nov 12, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation todo Milestone item

Comments

@pganguli
Copy link
Owner

pganguli commented Nov 12, 2023 •
edited

  • Add Introduction to README.md
  • Setup instructions in README.md
  • Usage instructions in README.md
  • Contributors / Acknowledgements in README.md
  • Link to manuscript (arxiv / bibtex / doi) in README.md
  • bibtex references file to all citations
  • Misc. supporting documents and other documentation in docs/ folder
@pganguli pganguli changed the title TODO: README.md README.md Nov 12, 2023
@pganguli pganguli added documentation Improvements or additions to documentation todo Milestone item labels Nov 12, 2023
@pganguli pganguli changed the title README.md Documentation Tasks Nov 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation todo Milestone item
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@pganguli