diff --git a/README.md b/README.md index dee66f2..8e60f09 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,31 @@ # ETCS European Train Control System implementation ETCS is a standard European safety system for railway interoperability between countries. This code tries to implement some of its features. Most DMI graphical functions work, as well as speed and distance monitoring. + +The DMI is the graphical interface. The EVC is the computer the DMI connects to. For connecting to ETCS within games like Simrail you should only need the DMI. + +# Building +Please note that you can also get builds from the [release page on github](https://github.com/cesarBLG/ETCS/releases). + +## Linux +1. Install dependencies: + * Ubuntu: `sudo apt install git cmake build-essential ninja-build clang git pkg-config libsdl2-dev libsdl2-ttf-dev libc-ares-dev` + * Arch Linux: `sudo pacman -S git cmake base-devel ninja clang pkgconf sdl2 sdl2_ttf c-ares` + +2. Download the ETCS repository: + ```bash + git clone https://github.com/cesarBLG/ETCS + cd ETCS + git submodule update --init --recursive + ``` + +3. Compile: + ```bash + cmake -S . -B build -DETCS_VENDORED=OFF + cmake --build build -j$(nproc --all) + ``` + +4. Install: + ```bash + sudo cmake --install build + ``` \ No newline at end of file