Compiling your program

Thanks to redox' cookbook, building programs is a snap. In this example, we will be building the helloworld program that cargo new automatically generates.

Step One: Setting up your program

To begin, go to your projects directory, here assumed to be ~/Projects/. Open the terminal, and run cargo new helloworld --bin. For reasons that will become clear later, you must make your program compile from a git repository, so run cd helloworld;git init to make helloworld a git repo, and git status to see which files you need to add to the repo. You should see something like this

On branch master

Initial commit

Untracked files:
  (use "git add <file>..." to include in what will be committed)


nothing added to commit but untracked files present (use "git add" to track)

Add all the files by running git add .gitignore Cargo.toml src/ and commit by running git commit -m "Added files to helloworld.".

There is only one more thing that must be done to set up your program. Go to the Cargo.toml of your project and add

name = "helloworld"
path = "src/"

to the bottom. Now the program is sufficiently set up, and it is ready to be added to your redox build.

Step Two: Adding your program to your redox build

To be able to access your program from redox, it must be added to both the build process and the filesystem. Adding your program to the filesystem is easy: go to your redox/filesystem.toml file, and look under the [packages] table. It should look like this:

#acid = {}
#binutils = {}
contain = {}
coreutils = {}
#dash = {}
extrautils = {}
#games = {}
#gcc = {}
#gnu-binutils = {}
#gnu-make = {}
installer = {}
ion = {}
#lua = {}
netstack = {}
netutils = {}
#newlib = {}
orbdata = {}
orbital = {}
orbterm = {}
orbutils = {}
#pixelcannon = {}
pkgutils = {}
ptyd = {}
randd = {}
redoxfs = {}
#rust = {}
smith = {}
#sodium = {}
userutils = {}

Under userutils = {} add a line for your own program:

userutils = {}
helloworld = {}

Now when building the filesystem, redox will look for a helloworld binary.

With the file system in order, you can now add your program to the build process by adding a recipie. Spoilers: this is the easy part.

Under redox/cookbook/recipes/, make a new directory called helloworld. In helloworld, create a file called

Remember the git repository ~/Projects/helloworld/? Its about to be relevant. In the file, write


With that, helloworld will now be built with and accessible from redox.

Step Three: Running your program

Go up to your redox/ directory and run make all. Once it finishes running, run make qemu, log in to redox, open the terminal, and run helloworld. It should print

Hello, world!