Skip to content

Commit fe246b5

Browse files
committed
docs: Install instructions updated for patch release
Instructions now acknowledge the "patch" releases.
1 parent 60b3889 commit fe246b5

1 file changed

Lines changed: 43 additions & 19 deletions

File tree

README.md

Lines changed: 43 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -67,14 +67,28 @@ and then add the neccessary data files. The steps are:
6767
[levels](https://github.com/swfans/swars-levels/releases).
6868
4. Now we finally get to this code repository. Download and unpack the source
6969
tarball or clone git repo. You can also try downloading the prebuilt *patch*
70-
release, in which case you should skip the next step; but that will only
71-
work if your Linux environment happens to be compatible to the one where
72-
the release patch package was built.
73-
5. Follow [building instructions](#general-building-instructions) below to get
74-
a compiled executable.
75-
6. After the build succeeded, do `make DESTDIR=<TARGET> install` in the
76-
directory where build commands were executed, to copy built files into the
77-
*\<TARGET\>* installation folder you've chosen.
70+
release; but that will only work if your Linux environment happens to be
71+
compatible to the one where the release patch package was built.
72+
Depending on what you've chosen, follow further steps:
73+
74+
Route "a" - compiling the game by yourself.
75+
76+
7.a. Follow [building instructions](#general-building-instructions) below to get
77+
a compiled executable and configuration files.
78+
8.a. After the build succeeded, do `make prefix=<TARGET> install` in the
79+
directory where build commands were executed, to copy built files into the
80+
*\<TARGET\>/swars* installation folder you've chosen. If you've built the
81+
binary yourself, you already have all the tools neccessary for that install
82+
command to work. After installation, verify the folder to make sure you
83+
didn't installed these files to `swars/swars/` directory; you can just
84+
move them one dir higher if that's the case.
85+
86+
Route "b" - using the prebuilt *patch* release.
87+
88+
7.b. Extract the downloaded patch file.
89+
8.b. Move all extracted files and folders to the selected installation folder.
90+
Place them all in one folder, so that sub-olders `conf`, `data`, `levels`
91+
and the executable file `swars` are all next to each other.
7892

7993
If all went well, you can now [start the game](#starting-the-game).
8094

@@ -140,17 +154,27 @@ If you've decided on the hand-compilation option, proceed with the following ste
140154
5. *[optional]* Create a `music` directory inside your chosen installation
141155
folder, and place the previously encoded `.ogg` files there.
142156
6. Now we finally get to this code repository. Download and unpack the source
143-
tarball or clone git repo. You can also download the prebuilt *patch*
144-
release, in which case you should skip the next step.
145-
7. Follow [building instructions](#building-on-windows) below to get
146-
a compiled executable and configuration files.
147-
8. After the build succeeded, do `make prefix=<TARGET> install` in the
148-
directory where build commands were executed, to copy built files into the
149-
*\<TARGET\>/swars* installation folder you've chosen. If you've built the
150-
binary yourself, you already have all the tools neccessary for that install
151-
command to work. After installation, verify the folder to make sure you
152-
didn't installed these files to `swars/swars/` directory; you can just
153-
move them one dir higher if that's the case.
157+
tarball or clone git repo. Or you can instead download the prebuilt *patch*
158+
release. Depending on what you've chosen, follow further steps:
159+
160+
Route "a" - compiling the game by yourself.
161+
162+
7.a. Follow [building instructions](#building-on-windows) below to get
163+
a compiled executable and configuration files.
164+
8.a. After the build succeeded, do `make prefix=<TARGET> install` in the
165+
directory where build commands were executed, to copy built files into the
166+
*\<TARGET\>/swars* installation folder you've chosen. If you've built the
167+
binary yourself, you already have all the tools neccessary for that install
168+
command to work. After installation, verify the folder to make sure you
169+
didn't installed these files to `swars/swars/` directory; you can just
170+
move them one dir higher if that's the case.
171+
172+
Route "b" - using the prebuilt *patch* release.
173+
174+
7.b. Extract the downloaded patch file.
175+
8.b. Move all extracted files and folders to the selected installation folder.
176+
Place them all in one folder, so that sub-olders `conf`, `data`, `levels`
177+
and the executable file `swars.exe` are all next to each other.
154178

155179
You can now [start the game](#starting-the-game).
156180

0 commit comments

Comments
 (0)