minor gitignore additions

[summerhack] / README.md

diff --git a/README.md b/README.md
index 1bb0b8a..2c9fb14 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,12 +1,16 @@
 Summerhack / The Lab
 ====================
+![GNU/Linux build status](https://github.com/TheLabDemos/summerhack/actions/workflows/build_gnulinux.yml/badge.svg)
+![FreeBSD build status](https://github.com/TheLabDemos/summerhack/actions/workflows/build_freebsd.yml/badge.svg)
+
 Summerhack was a short and sweet demo I've written during the summer of 2005
 for a random on-line competition. Mainly it was a showcase of the 3D engine I
-was writing back then with the help of Michael Georgoulopoulos, and which was
+was writing back then with the help of Michael Georgoulopoulos: 3dengfx, and which was
 hosted at: http://engfx3d.berlios.de (which has since gone off-line, see
-archived: https://web.archive.org/web/20060210131739/http://engfx3d.berlios.de )
+archived: https://web.archive.org/web/20060210131739/http://engfx3d.berlios.de ).
+You can find the last version of 3dengfx at: https://github.com/jtsiomb/3dengfx
 
-![screenshot](http://nuclear.mutantstargoat.com/sw/demos/shots/summerhack-thelab.jpg)
+![screenshot](http://nuclear.mutantstargoat.com/sw/demos/shots/summerhack-thumb.jpg)
 
 Pouet page: http://www.pouet.net/prod.php?which=18823
 
@@ -20,14 +24,7 @@ Credits
  - Demo code: John Tsiombikas (Nuclear)
  - 3D engine code: John Tsiombikas (Nuclear) and Michael Georgoulopoulos (Samurai)
  - Sound code: Vasilis Vasaitis (Savvy)
- - Music: Giannis Troumpadakis
-
-
-Issues
-------
-Depends on some unspecified version of 3dengfx, which is currently hard to
-get, build, and install prior to building this demo. I think it would be best to
-pull all the pieces together into this repository at some point.
+ - Music: Red Herring by Union Jack
 
 
 Original readme file
@@ -50,3 +47,50 @@ Released under the GPL, do whatever you wish with it.
 Contact info...
 http://thelab.demoscene.gr - nuclear@siggraph.org
 ```
+
+Build instructions
+------------------
+If you acquired the source code from the git repo, it does not include the
+binary data files (images, 3D models, and music). Grab the data file archive
+from: http://nuclear.mutantstargoat.com/sw/demos/summerhack-data.tar.gz and
+extract it in the project root directory, so that you now have the `img`, `geom`
+and `music` subdirectories in the `data` directory.
+
+If you got the source code from a full release archive of the demo, the data
+files are already there. Of course the release archive also contains
+pre-compiled binaries for multiple platforms.
+
+### UNIX
+
+The only dependencies are SDL 1.2 and OpenGL. After installing them, just type
+`make` to build the demo. For example under Debian GNU/Linux:
+
+    sudo apt-get install libgl-dev libsdl1.2-dev
+    make
+
+While on FreeBSD:
+
+    sudo pkg install mesa-libs sdl
+    gmake
+
+### Windows (MSVC)
+
+The sticking point with compiling on windows, especially with MSVC, is how to
+handle dependencies. OpenGL is not an issue, but SDL must be installed and the
+compiler/linker needs to be informed of its location.
+
+For new versions of MS Visual C++ (2015 or later), use vcpkg to install SDL 1.2.
+It should work automatically.
+
+For older versions of MSVC, download the pre-compiled SDL 1.2 package:
+https://libsdl.org/release/SDL-devel-1.2.15-VC.zip
+and unzip it in the libs directory of summerhack (so that the directory
+`libs\SDL-1.2.15` exists).
+
+Once SDL is taken care of, simply open the `summerhack.sln` project and hit F7
+(Build->Build Solution).
+
+
+### MacOS X
+
+TODO