Documentation
Getting started

Getting started

To get started using RF Swift, you first need to follow specific requirements.

Supported on

Platforms

Plateform x86_64/amd64 arm64/v8 riscv64
Windows ✅ ❓
Linux ✅ ✅ ✅
macOS ❓ ✅ (better inside a VM for USB devices)

Tested single-board computers

SBC Status Comments
Raspberry Pi 5 ✅ Works perfectly with most of the tools.
Milk-V Jupiyter ✅ Works perfectly with most of the tools, but slower than Raspberry Pi 5.
Milk-V Mars ❌ Software support is dead for the moment. Impossible to easily install Docker.
UP Squared Series ✅ Works perfectly with most of the tools.

Requirements

The minimum requirements to run the project are the following:

ℹ️
On Linux, Docker, BuildX, and go can be directly installed with install.sh script.

Docker is needed at least to run RF Swift containers. It can be directly your prefered package manager, such as APT or installed manually. From Linux systems, Docker can be installed quickly and easily with the following command-line:

curl -fsSL "https://get.docker.com/" | sh

Other dependencies will be also needed such as:

  • xhost: to install depending on your distribution
  • pulseaudio: to install depending on your distribution
  • golang: Go compiler
  • Optional buildx: For cross-compilation
⚠️
Make sure Docker Desktop runs in WSL2.
⚠️
This system will be soon supported at 100%

Next

Dive right into the following section to get started:

Quick start
Running RF Swift with pre-built images and binary.
 Developping and contributing
Compile binary and build images from sources, contribute to the project.
Last updated on
Documentation🚀 Quick Start