F.E.I.S/docs/Setup.md

69 lines
1.6 KiB
Markdown
Raw Normal View History

2021-12-31 11:15:50 +01:00
# Setting up the tools you need to work on F.E.I.S.
## Debian-ish Linux
### I just want to compile
Install the big general "I'm a real C/C++ dev !" package.
```console
$ sudo apt install build-essential
```
Install meson (the build system). I recommend doing so via python's `pip` to
get a more up-to-date version than what your distro packages might have
```console
$ pip install meson
```
2022-01-04 00:25:45 +01:00
Unfortunately this also means meson will not come with ninja so we need to install it ourselves :
```console
$ sudo apt install ninja-build
```
2021-12-31 11:15:50 +01:00
Install SFML
```console
sudo apt install libsfml-dev
```
Then checkout [this page](docs/Compiling.md) for instructions on how to compile
### I also want to contribute some code
Install `clang-format`
```console
$ sudo apt install clang-format
```
## Windows
2022-04-04 01:54:17 +02:00
### I just want to compile
#### MSYS2
2022-04-03 16:38:16 +02:00
2022-04-04 01:54:17 +02:00
MSYS2 is not the *usual* way to compile things for windows but it's the only
thing I know for now. If you know better, you're very welcome to do better
(and to also shower me with some of your knowledge, I absolutely *suck* at
build systems and would be delighted to hear from you)
2022-04-03 16:38:16 +02:00
Installing MSYS2 is pretty simple. [Follow their instructions](https://www.msys2.org/)
Once you're done `pacman -Syu`ing and `pacman -Su`ing your system, open a new
`MSYS2 MSYS` terminal and install the required packages :
```console
$ pacman -S \
mingw-w64-x86_64-meson \
mingw-w64-x86_64-cmake \
mingw-w64-x86_64-sfml \
2022-04-04 01:54:17 +02:00
mingw-w64-x86_64-boost \
mingw-w64-x86_64-ntldd-git
2022-04-03 16:38:16 +02:00
```
2022-04-04 01:54:17 +02:00
Once this is done, open a new `MSYS2 MinGW x64` terminal and follow the
[instructions on how to compile](docs/Compiling.md)