starfield

starfield.git
git clone git://git.lenczewski.org/starfield.git
Log | Files | Refs | Submodules | README | LICENSE

README (1001B)


      1 starfield
      2 ==============================================================================
      3 A simple game, built for linux and cross-compiled for windows.
      4 
      5 starfield: Dependencies
      6 ------------------------------------------------------------------------------
      7 Our expected build environment is linux, with the following dependencies:
      8 ```text
      9 - clang
     10 ```
     11 
     12 When building for linux, our dependency list is:
     13 ```text
     14 - wayland-protocols
     15 - wayland-client
     16 - alsa-libs
     17 - vulkan
     18 ```
     19 
     20 When building for windows, our dependency list is:
     21 ```text
     22 - python3              (build-time dependency)
     23 - msitools             (build-time dependency)
     24 - perl                 (build-time dependency)
     25 ```
     26 
     27 starfield: Building
     28 ------------------------------------------------------------------------------
     29 To clean any built artefacts, run:
     30 ```sh
     31 $ ./clean.sh
     32 ```
     33 
     34 To build for linux, run:
     35 ```sh
     36 $ ./build_linux.sh
     37 ```
     38 
     39 To build for windows, run:
     40 ```sh
     41 $ ./setup_win.sh # ensure this has been ran at least once
     42 $ ./build_win.sh
     43 ```