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!
Environment Setup
1. Install Python & Rust
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.
if these are not properly installed, the setup script mentioned below will fail miserably unless I ever make it more robust :)
Mac
Install python with whatever package manager you like, if not already installed
ex with homebrew:
brew install python
Install Rust with rustup:
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
Linux
Install python with whatever package manager you like, if not already installed
ex on Debian based systems with apt:
sudo apt update sudo apt install python3 python3-pip
Install Rust with rustup:
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
Windows
Install Python through the official installer
Download the Python installer from python.org.
Run the installer, and make sure to check the box that says "Add Python to PATH."
Follow the installation prompts.
Install Rust through the official installer
Download and run the Rust installer from rust-lang.org.
Follow the installation prompts.
2. Install and setup Docker (all platforms)
Follow the guidelines found here: Setting Up Docker
3. Run the setup script
To make installs easier, there is a python script found in the embedded-base repo that will install and build every python and rust package, along with building our docker image
Clone Embedded Base
To do this, you'll need to setup ssh keys on your machine. If you aren’t sure how to do this, take a look at some of our git resources linked further down in this doc, or the many resources online that can walk through this
Open the Embedded-Base repo, and run
python setup.py
This should work for any platform, but as mentioned above, it hasn’t been rigorously tested, so let someone know if it doesn't work
This script sets up a python virtual environment, installs packages within it, and binds the running of the docker container to the opening/closing of this virtual environment. For a list of tools that we use, take a look at this page
TODO DYLAN ADD THE DRAW,IO PAGE