If you already have MSYS2 installed, follow the directions below to setup access to the package repository. If not, download and install MSYS2 here first, then continue to follow the instructions below.

1. From the Start menu, open MSYS MinGW 64-bit.

2. Open /etc/pacman.conf and at the end of the file, add the following:

   [yaul-mingw-w64]
   SigLevel = Optional TrustAll
   Server = http://packages.yaul.org/mingw-w64/x86_64
   

3. Go back to the shell and sync and refresh the databases.

   pacman -Syy
   

4. Install everything.

   pacman -S \
     yaul-tool-chain-git \
     yaul \
     yaul-emulator-yabause \
     yaul-emulator-mednafen \
     yaul-examples-git
   

5. Once all the packages have been installed, close the existing shell and start a new one.

6. Test your environment by building an example.

Follow the directions below to setup access to the Arch Linux package repository, or build the packages yourself.

1. As root, open /etc/pacman.conf and at the end of the file, add the following:

   [yaul-linux]
   SigLevel = Optional TrustAll
   Server = http://packages.yaul.org/linux/x86_64
   

2. Sync and refresh the databases.

   pacman -Syy
   

3. Install everything. Keep in mind that yaul-emulator-kronos is only available on Linux. For MinGW-w64, install yaul-emulator-yabause instead.

   pacman -S \
     yaul-tool-chain-git \
     yaul \
     yaul-emulator-mednafen \
     yaul-emulator-kronos \
     yaul-examples-git
   

4. Once all the packages have been installed, close the existing shell and start a new one.

5. Test your environment by building an example.

There are currently no .deb packages available. You will need to build Yaul.

1. Clone the respository

   git clone "https://github.com/ijacquez/libyaul.git"
   

2. Initialize the submodules

   git submodule init
   

3. Update the registered submodules

   git submodule update
   

1. If the tool-chain package was installed, copy the template $TOOL_CHAIN_PREFIX/sh2eb-elf/yaul.env.in to your home directory as .yaul.env. This is your environment file.

   Otherwise, copy yaul.env.in from the root of this repository to your home directory as .yaul.env.

2. Read the environment file .yaul.env into your current shell.

   source $HOME/.yaul.env
   

3. Reading the environment file needs to be done every time a new shell is opened. To avoid having to do this every time, add the line below to your shell's startup file.

   echo 'source $HOME/.yaul.env' >> $HOME/.bash_profile
   

   If .bash_profile is not used, use .profile instead. This is dependent on your set up.

Open $HOME/.yaul.env in a text editor and change the following to define your environment:

1. Set the absolute path to the tool-chain in YAUL_INSTALL_ROOT.
2. If necessary, set YAUL_PROG_SH_PREFIX and YAUL_ARCH_SH_PREFIX.
3. Set the absolute path to where the libyaul source tree is located in YAUL_BUILD_ROOT.
4. Enable RTags/Irony/ccls support by setting YAUL_CDB to 1. To disable, set to 0 (zero).

Setting the wrong values may result in compilation errors.

1. Build and install the supported libraries.

   SILENT=1 make install-debug
   

   If any given library in Yaul is being debugged, use the install-debug target instead. Either release or debug can currently be installed at one time. It's possible to switch between the two in the same installation.

   To find more about other targets, call make list-targets.

2. Build and install the tools.

   SILENT=1 make install-tools
   

3. Test your environment by building an example.