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

Move information from the readme to wiki pages #22

Open
Victov opened this issue Oct 15, 2022 · 0 comments
Open

Move information from the readme to wiki pages #22

Victov opened this issue Oct 15, 2022 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@Victov
Copy link
Owner

Victov commented Oct 15, 2022

The readme has become bloated.
Move the following pieces of information to GH wiki pages, and leave behind links to relevant pages in the readme:

  • Install instructions
  • DBC retrieval instructions (.env setup)
  • Dockerised setup info
  • Console commands

The aim is to leave behind a readme where people can really see what the project is about at first glance and where they should go to get started, rather than a big all-encompassing knowledge document.
@Victov Victov added documentation Improvements or additions to documentation good first issue Good for newcomers labels Oct 15, 2022
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 good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@Victov