diff --git a/README.md b/README.md index a0eff49b..94927445 100644 --- a/README.md +++ b/README.md @@ -14,25 +14,18 @@ This project has only been tested on Solaris 2.6 running on a Sun Ultra 1 Creato While CSE2 normally uses CMake, this fork instead uses a Makefile for compiling on Solaris, due to the latest version of CMake available on the target being too old. -Before building, ensure that the required build directories exist. The following commands will accomplish that. +Compile the game by running `make`. On genuine hardware this will take considerable time. -``` -mkdir -p build/src/Backends/Rendering/Window/Software -mkdir -p build/src/Backends/Platform -mkdir -p build/src/Backends/Audio/SoftwareMixer -mkdir -p build/src/Backends/Controller -``` +After compilation is complete, move or copy the `CSE2` binary to `game_english`, and run it from there, making sure that the appropriate `libstdc++` is findable. If it's not automatically findable, you can point the environment variable `LD_LIBRARY_PATH` to its path. -Then you can compile the game simply by running `make`. On genuine hardware this will take considerable time. +CSE2 requires a `Config.dat` file, which we cannot currently produce from inside the Solaris environment. If you do not need a custom `Config.dat` (and you probably don't), simply rename the included `Config.dat_default` to `Config.dat` and move it into `game_english`. If you need to change some settings, compile the `DoConfig` program on a modern PC and use it to create your config file. The need for this workaround is considered a bug and should be fixed (but it most likely won't be). -After compilation is complete, copy the `CSE2` binary to `game_english`, and run it from there, making sure that the appropriate `libstdc++` is findable. If it's not automatically findable, you can point the environment variable `LD_LIBRARY_PATH` to its path. - -Note: CSE2 requires a `Config.dat` file, which we cannot currently produce from inside the Solaris environment. To create one, compile the `DoConfig` program on a modern PC and use it to create your config file. The need for this workaround is considered a bug and should be fixed. If you do not need a custom `Config.dat` (and you probably don't), simply rename the included `Config.dat_default` to `Config.dat` and move it into `game_english`. - -## Licensing (from the original README) +## Licensing Being a decompilation, the majority of the code in this project is proprietary and belongs to Daisuke "Pixel" Amaya. Modifications and custom code are made available under the MIT licence. See `LICENCE.txt` for details. + +Solaris port was created by John Lorentzson (Duuqnd), same license.