Update README organization #38
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ma4848
requested changes
Oct 25, 2025
| ## Table of Contents | ||
| 1. [Setup](#setup) | ||
| 1. [Linux](#linux) | ||
| 1. [Bare Metal](#bare-metal) |
Contributor
There was a problem hiding this comment.
this link doesn't work (bare-metal)
| 2. [WSL](#wsl) | ||
| 3. [Docker](#docker-1) | ||
| 3. [macOS](#macos) | ||
| 1. [Docker](#docker-2) |
Contributor
There was a problem hiding this comment.
this link doesn't work (docker-2)
README.md
Outdated
| If you've never contributed to a git repository before on this laptop or environment, you might receive an error message saying you don't have access. In that case visit [this tutorial](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/about-ssh) to set up SSH for local GitHub access. | ||
| After cloning the code, we need to set up our IDE: VSCode. If you already have it, great. Otherwise follow [this](https://code.visualstudio.com/download) tutorial. We recommend installing the mypy and autoDocstring VSCode extensions. Our autoDocstring settings are `Docstring Format: Numpy` and `Start On New Line: Start docstring on new line`. | ||
| After cloning the repository build the workspace and install the dependencies. |
Contributor
There was a problem hiding this comment.
missed comma, After cloning the repository, build....
README.md
Outdated
| ## First Time Setup | ||
| ### Get Ubuntu | ||
| To run our code you need an environment with Ubuntu 24. Select the guide below that fits your operating system. Some operating systems have multiple options. Here are our recommended installation options: |
Contributor
There was a problem hiding this comment.
missing comma I think, To run out code, you need...
README.md
Outdated
| Restart. | ||
| Follow the instructions to [Clone the Repository](#clone-the-repository) and [Setup the IDE](#setup-the-ide) before continuing. |
Contributor
There was a problem hiding this comment.
setup the ide link doesn't work
| - Press `F1` or `ctrl` `shift` `p` and choose `Tasks: Run Test Task` | ||
| - Run `colcon test --event-handlers=console_direct+` | ||
| The runs the tests and pipes the output to the terminal. To test `pi_main` make sure to type your password into the terminal after doing either option.. |
Added notes to solve rendering issues and long boot times in UTM
for more information, see https://pre-commit.ci
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Pull Request
What type of PR is this? (check all applicable)
Description
Update the main README so that it's organization makes more sense when setting up. Also minor updates to wording in various sections.
Related Tickets & Documents