diff options
| -rw-r--r-- | README.md | 47 | ||||
| -rw-r--r-- | README.rst | 46 |
2 files changed, 46 insertions, 47 deletions
diff --git a/README.md b/README.md deleted file mode 100644 index a451cec..0000000 --- a/README.md +++ /dev/null @@ -1,47 +0,0 @@ -# Starshatter: Open -Starshatter is a space combat simulator. - - -## Building -To build Starshatter you need CMake and a C++ compiler. The only supported target platform as of now is Windows and it -must be a 32-bit build. Both MinGW and MSVC are supported. - - -### Windows -#### MSVC -To build Starshatter with MSVC you will need Windows SDK and old stand-alone DirectX SDK. To point CMake to the Windows -SDK use the cache variables `WINDOWSSDK_LIBPATH` and `WINDOWSSDK_PATH`. In addition to these your environment is -expected to have `DXSDK_DIR` variable defined. - -After that follow your regular workflow with CMake. You can use IDE to run everything for you, e.g., Visual Studio and -Qt Creator both support CMake building. You can also use the CMake directly in command prompt or GUI and build it the -project manually. - - -#### MinGW -Make sure that you use 32-bit MinGW compiler - it is usually prefixed with "i686". IDEs also support this approach but -you need to properly configure toolchain/kit that the IDE will use. - - -### Linux -#### MinGW -To build Starshatter on Linux you will need to use MinGW. Just in the previous cases make sure that you use 32-bit -version that is usually prefixed with "i686". Use your host's CMake with `--toolchain` argument to configure the -project. After that follow the regular workflow. - - -## Installation -Installation targets are not fully configured as of now. - - -## Running -Once you build you should be able to run the game assuming that all shared objects (dynamic libraries) can be found -inside by the dynamic linker. If you are trying to run on Linux it means that you use `WINEPATH` to point to the MinGW's -bin directory and to the build directories that contain shared objects. For Windows it usually works right away or you -need to copy the libraries along the executable to one directory. - -To be able to play the game you also need the dat packages containing game resources. - - -## License -See <COPYING> and <NOTICE> files for licensing details. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..3807497 --- /dev/null +++ b/README.rst @@ -0,0 +1,46 @@ +Starshatter: The Open Source Project +==================================== +Starshatter is a military space combat simulator set in a distant future. + + +Where to start +^^^^^^^^^^^^^^ +Starshatter is a game. Start by enjoying it for a bit. Prebuilt game is available on itch.io_. Download the full game +package, unpack it, and run *Starshatter.exe*. There is a tutorial available along with storyline dynamic campaigns, and +one-off missions. + + +Contributing +^^^^^^^^^^^^ +You may contribute in various ways: writing and reviewing documents and lore, suggesting game balance changes, creating +new assets, coming up with ship names, and finally writing code. Whatever you want to do, start by saying hi on +discord_. + + +Building +^^^^^^^^ +Build systems are configured with CMake. Distributed prebuilt packages are built with MinGW and Makefiles, so you can +expect them to work. To run the game, install it after building with ``--install`` option. Running in build tree is not +supported at the moment. + + +MinGW +----- +You will need 32-bit MinGW compiler. Run CMake with ``--toolchain`` option or ``CMAKE_TOOLCHAIN_FILE`` variable to point +at included *cmake/toolchains/i686-w64-mingw32.cmake* or another appropriate toolchain definition. After initial +generation you can follow regular workflow. + + +MSVC +---- +You will need Windows SDK and old stand-alone DirectX SDK. Configure ``WINDOWSSDK_LIBPATH`` and ``WINDOWSSDK_PATH`` +CMake variables and ``DXSDK_DIR`` environment variable to point at their respective targets. + + +License +^^^^^^^ +See *COPYING* and *NOTICE* files for licensing details. + + +.. _itch.io: https://nthirtyone.itch.io/starshatter-open +.. _discord: https://discord.com/invite/6GFacfuyBP |