Traintastic - Model railway control software

About The Project

Traintastic is a client/server software application to control a model railway. It is in an early stage of development, it contains very limited functionality.

The project goal is to develop open source software that can control everything in your model railway layout. More information can be found using the links below:

Build Traintastic from source

This section is only for developers, if your just want to use it download Traintastic.

Requirements:

Client:
- C++ compiler: MSVC, GCC or Clang
- Visual Studio 16 2019 (Windows only)
- CMake 3.9+
- Qt 5.15+
Server:
- C++ compiler: GCC or Clang (MSVC doesn't work yet)
- Visual Studio 16 2019 (Windows only)
- CMake
- liblua5.3 (Linux only)
Manual:
- Python 3.6+ (older versions untested)
- cmarkgfm (pip3 install cmarkgfm)

Note: When cloning the source from git, git-lfs is required.

Build Traintastic client

From the project root go into the client directory: cd client
Create a build directory: cmake -E make_directory build
Go into the created build directory: cd build
Run CMake:
- Windows: cmake ../ -G "Visual Studio 16 2019" -A x64 -DCMAKE_BUILD_TYPE=Release
- Linux: cmake ../ -DCMAKE_BUILD_TYPE=Release
- macOS: cmake ../ -DCMAKE_BUILD_TYPE=Release -DQt5_DIR=/path/to/Qt/5.15.2/clang_64/lib/cmake/Qt5
Build traintastic-client: cmake --build . --config Release

Build Traintastic server

From the project root go into the server directory: cd server
Create a build directory: cmake -E make_directory build
Go into the created build directory: cd build
Configure CMake:
- Windows: cmake ../ -G "Visual Studio 16 2019" -A x64 -T ClangCL -DCMAKE_BUILD_TYPE=Release
- Linux: cmake ../ -DCMAKE_BUILD_TYPE=Release
- macOS: cmake ../ -DCMAKE_BUILD_TYPE=Release
Build traintastic-server: cmake --build . --config Release --target traintastic-server

Build Traintastic manual

From the project root go into the manual directory: cd manual
Run the build script: python3 builddoc.py html-single-page --output-dir build

3.2 KiB Originalformat Blame Verlauf