Raquet / Wiki / v1x / Compilation

Compilation

Table of Contents

Introduction

 Raquet uses an automatic build system via GNU Make to help quickly build the program. This Makefile will only look in the src/ directory for .c files, and any other needed files should be added to the makefile manually. In this makefile, you can find variables to modify for your preferred compiler, build directory, and more; but this page will only go over the basics of compiling the software to get it running as shown with the example program. This page also assumes you know how to navigate directories using the terminal. If you don't, check out this tutorial for linux, and this one for windows (Note: on MSYS2 for Windows you will need to type cd C: to get into your C drive properly).

Linux

First, install all the necessary dependencies with your terminal:

Debian:

sudo apt-get install clang sdl2-devel libsdl2-mixer-dev git

Arch:

sudo pacman -S clang sdl2 sdl2_mixer git

Gentoo:

sudo emerge -a sys-devel/clang media-libs/libsdl2 media-libs/sdl2-mixer dev-vcs/git

After all dependencies are installed, navigate to wherever you want to put your Raquet repo (i.e. a folder called Projects) and use git to get it from github.

git clone https://www.github.com/Sinislosion/Raquet.git

After the repo is downloaded, cd into it and run make to compile it. If you modify any source code, run make again to recompile the program. The resulting binary will be in bin/nix. If you modify a header file, or if something isn't chaning for some reason, run make clean to rebuild the entire program. (Caution: make clean will delete the entire bin folder, including everything inside of it, don't put sensitive files in the bin folder).

Windows

First, download the MSYS2 MingW terminal from msys2.org and install it to your hard drive. After installation, launch the MINGW64 terminal and navigate to where you want to store your Raquet repository. Once you're in the folder you want to be in, install the depencies with pacman via the following commands..

pacman -Syyu
pacman -S make git mingw-w64-x86_64-clang mingw-w64-x86_64-SDL2 mingw-w64-x86_64-SDL2_mixer

Then, use git to download the repo.

git clone https://www.github.com/Sinislosion/Raquet.git

After the repo is downloaded, cd into it and run make to compile it. If you modify any source code, run make again to recompile the program. The resulting binary will be in bin/win. If you modify a header file, or if something isn't chaning for some reason, run make clean to rebuild the entire program. (Caution: make clean will delete the entire bin folder, including everything inside of it, don't put sensitive files in the bin folder).