This is an old revision of the document!
Table of Contents
Getting Started
The Wonderful toolchain can currently be installed on:
- Linux
- Windows (via MSYS2)
Once you’re done following this tutorial, feel free to install the necessary tools for the target of your choice by following the target-specific instructions. You may also want to visit our Discord server to chat with fellow Wonderful users - an IRC bridge may be provided in the future, if user demand exists.
Linux
To install Wonderful on your computer, you will need:
- a Linux distribution released sometime in the last decade (maybe a bit more),
- a CPU architecture compatible with x86_64 or AArch64,
- the following command-line tools provided by your distribution: bash, git, make.
Downloads
Installation instructions
- Create the
/opt/wonderful
directory:sudo mkdir /opt/wonderful
. Other installation locations are not supported at this time.- On typical Linux installations,
/opt
can be only written to by the root user. This is whysudo
is used here to elevate permissions.
- Give permissions to
/opt/wonderful
to your current user:sudo chown -R "$USER" /opt/wonderful
.- This allows all subsequent commands, including
wf-pacman
updates, to be executed without elevated permissions.
- Extract the bootstrap to
/opt/wonderful
:cd /opt/wonderful/ && tar xzvf [path_to_bootstrap_tar_gz]
. - Run
/opt/wonderful/bin/wf-pacman -Syu wf-tools
(no sudo - you don’t need root!) to synchronize and update the toolchain’s package manager. - Run
source /opt/wonderful/bin/wf-env
to configure the toolchain's environment variables.- It is a good idea to add this to the end of
~/.profile
- this way, they will be automatically applied every time you restart the shell.
Troubleshooting
- If you run into error
setting certificate file: /etc/ssl/certs/ca-certificates.crt
while trying to use wf-pacman, you may need to install your distribution’s SSL certificates package (f.e. ca-certificates on Debian).
Windows (via MSYS2)
To install Wonderful on your computer, you will need:
- a recent version of Windows - Windows 10 and above are supported,
- a CPU architecture compatible with x86_64.
Installation instructions (Installer)
Required files:
- Install the MSYS2 environment.
- Install the Wonderful toolchain from the above installer. (If you’ve installed MSYS2 to a different directory than
C:\msys64
, adjust it in the Wonderful installer to match.) - Run
Wonderful Toolchain Shell
from the Start menu.
This approach is a little experimental, so if it doesn’t work for you, feel free to try the Manual steps below.
Installation instructions (Manual)
Required files:
- Install the MSYS2 environment.
- From the Start Menu, launch the MSYS UCRT64 shell. This shell is used to interact with the toolchain (make, wf-wswantool, etc).
- Install some useful packages:
pacman -S base-devel ca-certificates
. - Create the
/opt/wonderful
directory:mkdir /opt/wonderful
. Other installation locations are not supported at this time. - Extract the bootstrap to
/opt/wonderful
(f.e.cd /opt/wonderful/ && tar xzvf [path_to_bootstrap_tar_gz]
). - Run
/opt/wonderful/bin/wf-pacman -Syu wf-tools
(no sudo - you don’t need root!) to synchronize and update the toolchain’s package manager. - Run
source /opt/wonderful/bin/wf-env
to configure the toolchain's environment variables.- It is a good idea to add this to the end of
~/.profile
- this way, they will be automatically applied every time you restart the shell.
Alternative: Windows (via WSL2)
Since WSL2 is compatible with Linux, one can follow the Linux installation instructions to get Wonderful running on top of Windows this way.
- If you run into error:
could not open file: /etc/mtab: No such file or directory
while trying to use wf-pacman, the following command can create the missing file:sudo ln -s /proc/self/mounts /etc/mtab
macOS
Native macOS support is currently not available. For the time being, it is recommended to use a Linux virtual machine.