For everything onboarding, this is the place to be. We work hard to ensure you can contribute to NER firmware on any platform, but note that many of us who developed these docs are on Linux, and are less familiar with issues that may pop up on other platforms. With that being said, if anything below does not make sense or doesn’t seem to be working as expected, please reach out to one of us on slack in #s_embbeddedembedded-software channel!
| Table of Contents | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
...
To get ready for this guide, run with Windows Terminal app:
| Code Block |
|---|
wsl --update |
1. Install Python
We use various packages and tools from these ecosystems, and so its essential to have both installed on your machine. Obviously, you can skip this step if you already have these installed.
...
| Code Block |
|---|
sudo apt update sudo apt install python3 python3-pip python3-venv |
2
...
Same deal with package managers as above, but generally:
Mac
| Code Block |
|---|
brew install git |
Linux and WSL
| Code Block |
|---|
sudo apt update && sudo apt upgrade -y
sudo apt install git |
...
. Install and setup Docker (all platforms)
Follow the guidelines found here to install Docker (Linux) or Docker Desktop (Macos and Windows) Setting Up Docker
Windows users: Turn on WSL integration in Docker Desktop settings. Do this by going to Settings → Resources → WSL Integration → Turn on “Ubuntu”
...
3. Setup Scripts
| Info |
|---|
It is strongly recommended to maintain a directory structure like the following |
...
| Info |
|---|
Windows users: For better build performance, clone this to a folder within the Ubuntu disk. Do this by entering the ~ folder with |
Open the Embedded-Base repo, and run
...