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

Update project README #393

Closed
ra0x3 opened this issue Dec 5, 2022 · 0 comments · Fixed by #418
Closed

Update project README #393

ra0x3 opened this issue Dec 5, 2022 · 0 comments · Fixed by #418
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Milestone

Comments

@ra0x3
Copy link
Contributor

ra0x3 commented Dec 5, 2022

  • Project README should include basic instructions for getting started "from scratch"
  • Some times from the mdbook might need to be referenced/copied into the README. E.g., installing dependencies, project structure, etc
  • A dev should be able to read the project README and understand how to get up and running (and we point them to the mdbook for more detail)
@ra0x3 ra0x3 added documentation Improvements or additions to documentation good first issue Good for newcomers labels Dec 5, 2022
@ra0x3 ra0x3 mentioned this issue Dec 5, 2022
16 tasks
@deekerno deekerno self-assigned this Dec 9, 2022
@ra0x3 ra0x3 added this to the Beta-3 milestone Jan 27, 2023
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 good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants