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

Update readme #1

Open
Nikronic opened this issue Nov 20, 2022 · 0 comments
Open

Update readme #1

Nikronic opened this issue Nov 20, 2022 · 0 comments
Assignees
@Nikronic
Labels
documentation Improvements or additions to documentation

Comments

@Nikronic
Copy link
Owner

People don't have time for all these "random" stuff, prepare a proper readme containing:

  1. what this project is
  2. how to run it
  3. warning about issues
  4. citation and related projects and acknowledgement
@Nikronic Nikronic added the documentation Improvements or additions to documentation label Nov 20, 2022
@Nikronic Nikronic self-assigned this Nov 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@Nikronic Nikronic

Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Nikronic