Rewrite of installation steps v1.1

"###" looks very similar to "**", so I ditched the second.
master
ButterFinger 2022-05-08 21:13:01 +02:00 committed by GitHub
parent c948b77fa9
commit 730d694ada
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 3 additions and 5 deletions

View File

@ -77,29 +77,27 @@ Once installed, you'll be able to launch OpenSpades from inside the desktop menu
#### Installing and launching
**To launch the built game without installing:**
To launch the built game without installing:
```
cd $REPO_DIRECTORY/openspades.mk; bin/openspades
```
**To install the game to your system (recommended), take the following steps:**
To install the game to your system (recommended), take the following steps:
1. `sudo make install`
**note**: If you have a previous installation of OpenSpades, you have to uninstall it manually by `sudo rm -rf /usr/local/share/games/openspades` before installing a new one, or else it might load old resources.
2. Launch the game by typing `openspades` into command line, or search for it from start menu.
**Alternatively, to install the game to a different directory, take the following steps:**
Alternatively, to install the game to a different directory, take the following steps:
1. Copy the Resources directory into bin (or else the game won't launch):
```cp -r ./Resources ./bin/```
**note**: If you plan on distributing it, remember to remove CMake files and folders from Resources.
2. Move the "/openspades.mk" folder somewhere else, for example `/home/user/Games`, or `/opt/games` and rename it to "/OpenSpades".
3. The game's launcher is located at `bin/openspades`. You can create a shortcut for it on the desktop or a `.desktop` file placed in `/usr/share/applications/` for it to appear in Start Menu. Make sure to set the `bin` directory as the shortcut's working directory, or else you will get an error about missing resources.
**note**: If you choose a directory outside of your `/home/user`, for example `/opt/games`, remember to *chmod* the game launcher's permissions to 755.
After successful installation, optionally you can remove the source code and build outputs to save disk space (~100MB)