Documentation
🧑‍đŸŗ Development
Compiling RF Swift

Compiling RF Swift

The project can install from source by following the simple steps:

Installing RF Swift from source

Get binary from GitHub

Get the latest commit from the the official repository:

git clone https://github.com/PentHertz/RF-Swift.git

Use the installation script

Two scripts are available to install all development tools if not installed and build the project:

  • install.sh: Installation script for Linux, handling also the installation of Docker (also on Steam Deck), Buildx, and go.
  • build-windows.bat

If you are running the install.sh script, it will ask you if you want to install it for a Steam Deck. If yes, this will also unlock Steam OS from read-only.

./install.sh 
[+] Checking Docker installation
Are you installing on a Steam Deck? (yes/no)
Choose an option:

After this process, install.sh will take care for Golang, Docker, Build X, and compose installation.

On Linux, you will have also the choice to make an alias for this binary:

Do you want to create an alias for the binary? (yes/no):
ℹī¸
The alias will allow you to start the binary with rfswift command.

And then ask you if you want to build a Docker image (1), or pull an existing one (2), or exit the process (3):

Docker is already installed. Moving on.
Docker Buildx is already installed. Moving on.
Docker Compose v2 is already installed. Moving on.
[+] Installing Go
golang is already installed in /usr/local/go/bin. Moving on.
[+] Building RF Switch Go Project
RF Switch Go Project built successfully.
Do you want to build a Docker container, pull an existing image, or exit?
1) Build Docker container
2) Pull Docker image
3) Exit
Choose an option (1, 2, or 3):

You can always choose to build images, or pull images later.

Beak your own images
Make your own images, save space and enjoy your environment
 Managing images
List local and remote images, and pull them from the official registry

Running the container

After building, or pulling an existing image, you can run the container and enjoy the included tools !

sudo ./rfswift run -i penthertz/rfswift:sdr_full -n supercontainername

Restarting a container

You can create as many fresh container you want, but sometimes you want to get back to previous job.

To restart a container, you can do it with the following command using -c nameofthecontainer:

sudo ./rfswift exec -c supercontainername

Next

Now your are ready to use RF Swift with provided images, build your own images, and contribute on the Go binary and the content of images.

Getting Started
Learn how to run RF Swift with provided images
Last updated on
🧑‍đŸŗ DevelopmentBuilding images