yquake2/yquake2remaster
0
0
Fork 0
mirror of https://github.com/yquake2/yquake2remaster.git synced 2025-02-16 17:11:03 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update the README to match reality.

Browse source
This commit is contained in:
Yamagi Burmeister 2018-08-14 15:35:51 +02:00
parent 692c544f30
commit 1aef881f27
2 changed files with 10 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
CONTRIBUTE
View file

@ -8,7 +8,7 @@
===============================================================================
At this time there're no open tasks regaring Quake II. Nevertheless the hints
At this time there're no open tasks regaring Quake II. Nevertheless some hints
for working with the code:
- Sign up for a Github account and fork our yquake2 repository. This allows the
@ -22,7 +22,7 @@ for working with the code:
it's still a disaster. Therefore:
- Do only one change at a time!
- Test after each change (play at least through base1.bsp)
- Commit early and commit often to create a fine grained history. This helps
- Commit early and commit often to create a fine grained history. This helps
"git bisect" to find bugs and errors.
- Do not try to clean up things or even rewrite code that you do not
understand to 110%! Even small behavioral changes can introduce gameplay

23
README.md
View file

@ -186,33 +186,26 @@ To compile Yamagi Quake II from source, you need the following dependencies,
including development headers:
- A GCC-compatible compiler like GCC, MinGW (see below) or Clang.
- GNU make or cmake.
- GNU make.
- A libGL implementation with OpenGL system headers.
- SDL 2.0.
- libogg, libvorbis and libvorbisfile.
- A OpenAL implementation, openal-soft is highly recommended.
- zlib.
Yamagi Quake II has 2 build systems:
- A classic GNU Makefile.
- A CMakeFile.
Both build system provide the same options and features, it's up to the user to
decide which one to use.
While Yamagi Quake II ships with an optional CMakeFile using GNU make for
release builds is highly recommended. The GNU Makefile offers more options
and is well tested.
#### On Linux distribution or BSD systems
On debian based distributions (including Ubuntu and Mint) the dependencies can
be installed with: `apt-get install build-essential libgl1-mesa-dev libsdl2-dev
libogg-dev libvorbis-dev libopenal-dev zlib1g-dev`
libopenal-dev`
On OS X we recommend using Homebrew - https://brew.sh - to install the
dependencies: `brew install sdl2 libvorbis libogg openal-soft`
dependencies: `brew install sdl2 openal-soft`
On FreeBSD you'll need something like: `pkg install gmake libGL sdl2 libogg
libvorbis openal-soft`
On FreeBSD you'll need something like: `pkg install gmake libGL sdl2 openal-soft`
#### On Windows