diff --git a/README b/README index 88389b2..f3652fc 100644 --- a/README +++ b/README @@ -1,32 +1,31 @@ Work in progress orbital shipping game + Dependencies: libTangerine: https://gitlab.com/cinnaboot/tangerine - Catch2 (for tests): - https://github.com/catchorg/Catch2/blob/devel/docs/Readme.md + imgui: https://github.com/ocornut/imgui -TODO: - add GUI to demo application for modifying orbit parameters - add equations for parabolic and hyperbolic trajectories - make algorithm for Hohmann transfer orbits - you know, make the actual game + SDL2: https://www.libsdl.org/index.php + glew: https://www.opengl.org/sdk/libs/GLEW/ + glm: https://github.com/g-truc/glm + Catch2 (only for tests): https://github.com/catchorg/Catch2 Building: install dependencies for your environment: - Arch) $ sudo pacman -S assimp glew glm sdl2 catch2 gcc make + Arch) $ sudo pacman -S glew glm sdl2 catch2 gcc make + Fedora) $ sudo dnf install glew-devel glm-devel SDL2-devel \ catch-devel gcc-c++ make cmake - NOTE: fedora (33) see note below about assimp + checkout, and initialise submodule dependencies: $ git submodule update --init --recursive + build: $ make - binaries will be in ./bin - - NOTE: if you get errors regarding assimp when building, you can build a - recent version of assimp by passing USE_INTERNAL_ASSIMP=y to make + optionally) + $ make tests - $ USE_INTERNAL_ASSIMP=y make + binaries will be in ./bin