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

Create how to install section in main README #65

Open
glopesdev opened this issue Apr 15, 2024 · 0 comments
Open

Create how to install section in main README #65

glopesdev opened this issue Apr 15, 2024 · 0 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@glopesdev
Copy link
Member

Currently the hardware and software install notes are mixed between the hardware capabilities and description. It would be easier for someone setting up the system to have a single How to install section at the top which goes through the dependencies and steps to get every component running.

This section can itself have subsections for each of the modules, in case people want to know what dependency is necessary for what module (e.g. if they want to install only part of the hardware).

@glopesdev glopesdev added the documentation Improvements or additions to documentation label Apr 15, 2024
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

When branches are created from issues, their pull requests are automatically linked.

3 participants