diff --git a/BUILD.md b/BUILD.md index 1f86ac1c0..aa4679441 100644 --- a/BUILD.md +++ b/BUILD.md @@ -7,7 +7,8 @@ Status](https://github.com/ZetaGlest/zetaglest-source/issues/25) * **Getting the code:** * [Set up the repositories locally](https://github.com/ZetaGlest/zetaglest-source/blob/develop/BUILD.md#set-up-the-repositories-locally) - * [cloning your forks](https://github.com/ZetaGlest/zetaglest-source/blob/develop/BUILD.md#procedure-for-cloning-your-forks) + * [cloning](https://github.com/ZetaGlest/zetaglest-source/blob/develop/BUILD.md#procedure-for-cloning) + * [Extra options for compiling](https://github.com/ZetaGlest/zetaglest-source/blob/develop/BUILD.md#extra-options-for-compiling) * **Dependencies** * [Windows](https://github.com/ZetaGlest/zetaglest-source/blob/develop/BUILD.md#windows) @@ -16,7 +17,7 @@ Status](https://github.com/ZetaGlest/zetaglest-source/issues/25) * [Mac OS](https://github.com/ZetaGlest/zetaglest-source/blob/develop/BUILD.md#mac-os) * [BSD](https://github.com/ZetaGlest/zetaglest-source/blob/develop/BUILD.md#bsd) -* * [Installing](https://github.com/ZetaGlest/zetaglest-source/blob/develop/BUILD.md#installing) +* [Installing](https://github.com/ZetaGlest/zetaglest-source/blob/develop/BUILD.md#installing) * **Compiling** * [Windows](https://github.com/ZetaGlest/zetaglest-source/blob/develop/BUILD.md#windows) @@ -49,7 +50,7 @@ repo directories are in the same directory, adjacent to each other (and ### Note -If you have cloned the repositories this way, do not use the +If you have cloned the repositories using your forks, do not use the `git_update.sh` provided in the source directory. See [syncing](https://github.com/ZetaGlest/zetaglest-source/blob/develop/CONTRIBUTING.md#syncing) for information on how to sync your repo with the main upstream (no, @@ -173,12 +174,17 @@ cmake to use the correct compiler) CC=`which egcc` CXX=`which eg++` cmake .. -DINSTALL_DIR_DATA= +Now that the build configuration has been set, run make: + make The zetaglest binaries will be in the `build/` directory. Run './zetaglest' to start the game. +See [running](https://github.com/ZetaGlest/zetaglest-source#running) for +detailed information about running a server or hosting a game. + The value for INSTALL_DIR_DATA is written to the game when compiled, therefore if you ever move your data directory, you will have to recompile ZetaGlest. diff --git a/INSTALL.md b/INSTALL.md index 70c5e8e0d..0670eb436 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -17,13 +17,8 @@ the game from source and run it without installing ## Windows -### Installer - -[https://github.com/ZetaGlest/windows-installer](ZetaGlest Windows Installer) - -### Build and Install from source code - -https://github.com/ZetaGlest/zetaglest-source/blob/develop/mk/windows/README.md +* [Installer](ZetaGlest Windows Installer) +* [Build and Install from source code](https://github.com/ZetaGlest/zetaglest-source/blob/develop/mk/windows/README.md) ## Linux, Mac OS, BSD @@ -52,12 +47,11 @@ Make and install the program: make make install -The binary will be in CMAKE_INSTALL_PREFIX/games (i.e. /usr/games) +The binaries will be installed to CMAKE_INSTALL_PREFIX/games (i.e. /usr/games) -Before you run `make`, you can confirm the installation directories of -files that will be installed by entering `cmake .. -LH`. For example, -These are the destination directories when -`-DCMAKE_INSTALL_PREFIX=/home/andy/local` is used: +Before you run `make`, you can confirm the installation directories by +entering `cmake .. -LH`. For example, These are the destination +directories when `-DCMAKE_INSTALL_PREFIX=/home/andy/local` is used: ``` // The installation path for binaries @@ -80,6 +74,9 @@ If you wish to install to a location that does not require super-user privileges, change '/usr' to a location to which you have write access. +See [running](https://github.com/ZetaGlest/zetaglest-source#running) for +detailed information about running a server or hosting a game. + The value for INSTALL_DIR_DATA is written to the game when compiled, therefore if you ever move your data directory, you will have to recompile ZetaGlest. diff --git a/README.md b/README.md index b7a86b0f4..01cd8b5e1 100644 --- a/README.md +++ b/README.md @@ -14,13 +14,15 @@ in one of 17 naturally looking settings, which, like the unit models, are crafted with great attention to detail. A lot of additional game data can be downloaded from within the game at no cost. -* **README Contents** - * [Stay Informed (Updates)](https://github.com/ZetaGlest/zetaglest-source#stay-informed-updates) - * [Project Goals](https://github.com/ZetaGlest/zetaglest-source#why-this-fork-project-goals) - * [Download executable files](https://github.com/ZetaGlest/zetaglest-source#download-executable-files) - * [Extra Tech trees, mods, tilesets, scenarious (not yet available on the ZetaGlest server)](https://github.com/ZetaGlest/zetaglest-source#extra-tech-trees-mods-tilesets-scenarious-not-yet-available-on-the-zetaglest-server) - * [Contributing and Testing](https://github.com/ZetaGlest/zetaglest-source#contributing-and-testing) - * [Contact](https://github.com/ZetaGlest/zetaglest-source#contact) +**README Contents** + +* [Stay Informed (Updates)](https://github.com/ZetaGlest/zetaglest-source#stay-informed-updates) +* [Project Goals](https://github.com/ZetaGlest/zetaglest-source#why-this-fork-project-goals) +* [Download executable files](https://github.com/ZetaGlest/zetaglest-source#download-executable-files) +* [Running](https://github.com/ZetaGlest/zetaglest-source#running) +* [Extra Tech trees, mods, tilesets, scenarious (not yet available on the ZetaGlest server)](https://github.com/ZetaGlest/zetaglest-source#extra-tech-trees-mods-tilesets-scenarious-not-yet-available-on-the-zetaglest-server) +* [Contributing and Testing](https://github.com/ZetaGlest/zetaglest-source#contributing-and-testing) +* [Contact](https://github.com/ZetaGlest/zetaglest-source#contact) **[System Requirements](https://zetaglest.github.io/docs/system_requirements.html)**