doc/building

   1 Dependencies
   2 ============
   3
   4         GLEW, GLM, SDL2, SDL2_image, SDL2_net, SDL2_ttf, OpenAL, freealut, zlib
   5
   6         CppUnit for tests
   7
   8 archlinux: pacman -S glew glm sdl2 sdl2_image sdl2_net sdl2_ttf openal freealut zlib cppunit
   9
  10 manual:
  11         CppUnit http://sourceforge.net/projects/cppunit/
  12         GLEW    http://glew.sourceforge.net/
  13         GLM     http://glm.g-truc.net/0.9.6/index.html
  14         OpenAL  http://openal.org/
  15         SDL     http://www.libsdl.org/
  16         zlib    http://zlib.net/
  17
  18
  19 Makefile
  20 ========
  21
  22 Targets
  23 -------
  24
  25 all:
  26         build everything
  27
  28 release (default), debug, profile:
  29         build executables tuned for running, debugging, and profiling
  30
  31 run:
  32         build and execute the main binary with state path set to ./saves
  33
  34 server:
  35         same as run, only in server mode
  36
  37 server:
  38         same as run, only in client mode and the save path is set to
  39         ./client-saved to prevent clashes with a running `make server`
  40
  41 test:
  42         build and run unittests
  43
  44 gdb, cachegrind, callgrind:
  45         build the binary suited for given tool and launch
  46
  47 clean:
  48         remove intermediates
  49
  50 distclean:
  51         remove intermediates and artifacts
  52         (also those generated by tool invocations!)
  53
  54
  55 Variables
  56 ---------
  57
  58 CXX, LXX:
  59         compiler/linker used for C++ sources/objects
  60
  61 LIBS:
  62         names of libraries (for pkg-config)
  63
  64 CPPFLAGS, CXXFLAGS, LDXXFLAGS:
  65         flags for the preprocessor, compiler, and linker
  66
  67 DEBUG_FLAGS, PROFILE_FLAGS, RELEASE_FLAGS:
  68         flags for building binaries in debug, profile, and release mode