Modernize Readme and add AppVeyor badge

This commit is contained in:
Ewout ter Hoeven 2019-01-22 11:08:46 +01:00 committed by GitHub
parent 2af6b58a52
commit ba79301606
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23

View file

@ -1,3 +1,5 @@
## Capture The Flag [![AppVeyor Build Status](https://ci.appveyor.com/api/projects/status/github/yquake2/ctf?branch=master&svg=true)](https://ci.appveyor.com/project/yquake2/ctf)
This is a 64 bit clean and bugfixed version of id Software's Quake II
addon pack "Capture The Flag", developed by David 'Zoid' Kirsch. Hundred
of type errors and strange constructs were fixed, thus this version
@ -5,27 +7,27 @@ should run much more stable than the old SDK version. While it may work
with every Quake II client, the "Yamagi Quake II" client is highly
recommended. For more Information visit http://www.yamagi.org/quake2.
Installation for FreeBSD, Linux and OpenBSD:
--------------------------------------------
1. Type "make" or "gmake" to compile the game.so.
### Installation for FreeBSD, Linux and OpenBSD:
1. Type `make` or `gmake` to compile the game.so.
2. Copy release/game.so to the ctf/ subfolder of your Quake II
installation. The CTF gamedata is part of the 3.20 point release.
3. Start the game with "./quake2 +set game ctf".
3. Start the game with `./quake2 +set game ctf`.
### Installation for OS X:
Installation for OS X:
----------------------
1. Copy game.dll from the zip-archive to ctf/.
2. Start the game with "quake2 +set game ctf"
2. Start the game with `quake2 +set game ctf`
If you want to compile 'ctf' for OS X from source, please take a look at
the "Installation" section of the README of the Yamagi Quake II client.
In the same file the integration into an app-bundle is explained.
Installation for Windows:
-------------------------
### Installation for Windows:
1. Copy the game.dll to the ctf\ subfolder of your Quake II
installation. The CTF gamedata is part of the 3.20 point release.
2. Start the game with "quake2.exe +set game ctf".
2. Start the game with `quake2.exe +set game ctf`.
If you want to compile 'ctf' for Windows from source, please take a
look at the "Installation" section of the README of the Yamagi Quake