Requirements
Before you can start developing, check that your development set up meets the requirements highlighted below.
1. You run Linux
The ASE docs and commands are all written for Linux and the ASE team will not be able to help you with OS-related problems if you are not running Linux. We recommend running Linux in a dual-boot setup or from within a virtual machine. Most operations are also supported in WSL2.
2. You have Docker installed
We provide many Docker images and docker compose files that you can use to run ASE software without needing any additional software. Hence, having Docker installed on your host system is a requirement. When you install Docker, make sure that you install the entire suite (including Docker compose).
Make sure to follow the Docker post-install guide to avoid a lot of permission denied
errors.
3. You have some basic Linux knowledge
You should know:
- How to use SSH to run code on the Rover1 debix
- How to use SCP to copy files to and from the Rover1 debix
- How to navigate around the Linux filesystem using
cd
,ls
,mv
,cp
and friends - How to use Makefiles
- How to open, save and quit
vi
orvim
- What environment variables are and how to set, unset and print them
- How to use the
shutdown
andreboot
command - How to use
curl
to download files
If any of these points sounds new to you, we highly recommend to take a moment and catch up by Googling around and refreshing your Linux understanding. It will help you a lot in understanding the ASE framework.
4. You use VSCode
While not a hard requirement, using VSCode allows the ASE team to help you better. Additionally, we will describe how to set up specific parts of the framework using VSCode, so it will be easier for you to get started.