git.cworth.org Git - vogl/blob - README.md

   1 vogl
   2 =============
   3
   4 ## Warning ##
   5
   6 This project is alpha^2 right now. If you are up for suffering through a bit of pain with early releases, please continue on - we'd love to have your help...
   7
   8 ## Build ##
   9
  10 To build the vogl chroots (uses schroot), do the following:
  11
  12     vogl/bin/chroot_build.sh --i386 --amd64
  13
  14 You should now be ready to build in your chroots. Something like any of these:
  15
  16     vogl/bin/mkvogl.sh --release --amd64
  17     vogl/bin/mkvogl.sh --debug --amd64 --i386 --clang34 --verbose
  18     vogl/bin/mkvogl.sh --release --amd64 --i386 --gcc48 --CRNLIB_ENABLE_ASSERTS
  19
  20 Note that you do _not_ have to use the chroots or mkvogl.sh to build. You could do your own cmake (cmake vogl/src) and go from there. It's up to you to get the dependencies correct though. Look at vogl/bin/chroot_configure.sh to see how the chroots are set up. The source for mkvogl is in vogl/bin/src/mkvogl.cpp - it's just a simple cpp wrapper around cmake.
  21
  22 ## Capturing ##
  23
  24     vogl/bin/steamlauncher.sh --gameid vogl/vogl_build/bin/glxspheres32
  25     vogl/bin/steamlauncher.sh --gameid vogl/vogl_build/bin/glxspheres64 --amd64
  26
  27 You should now have something like the following in your temp directory:
  28
  29     /tmp/vogltrace.glxspheres64.2014_01_20-16_19_34.bin
  30
  31 ## Replay ##
  32
  33     vogl/vogl_build/bin/voglreplay64 /tmp/vogltrace.glxspheres64.2014_01_20-16_19_34.bin
  34
  35 or
  36
  37     vogl/vogl_build/bin/vogleditor64 ; and then open the trace file...
  38
  39 ## Directory structure ##
  40
  41 The directory structure for vogl currently looks like this:
  42
  43         vogl/
  44             bin/
  45                 chroot_build.sh ; script to build/rebuild chroots
  46                 chroot_configure.sh ; script to build libs to chroots (used by chroot_build.sh)
  47                 gligen_run.sh ; run vogl_build/bin64/gligen.sh (put in glspec)
  48                 gligen_copy_inc_files.sh ; copy glspec/*.inc
  49                 set_compiler.sh ; switch chroot default compiler
  50             external/ ; external source (libunwind, etc.)
  51             glspec/
  52             src/ ; vogl source
  53             vogl_build/
  54                 bin/ ; destination for binaries
  55             vogl_extbuild/
  56                 i386/   ; external projects untar'd & built here
  57                 x86_64/ ;
  58
  59 ## QtCreator tagging and building ##
  60
  61   See qtcreator/qtcreator.md file: [qtcreator.md](qtcreator/qtcreator.md)
  62
  63 ## Vogl Dev List ##
  64
  65     http://lists.voglproj.com/listinfo.cgi/dev-voglproj.com
  66
  67 ## Useful Links ##
  68
  69 Vogl Wiki
  70
  71 * https://github.com/ValveSoftware/vogl/wiki
  72
  73 OpenGL documentation/references
  74
  75 * 4.x: http://www.opengl.org/sdk/docs/man/
  76 * 3.3: http://www.opengl.org/sdk/docs/man3/
  77 * 2.1: http://www.opengl.org/sdk/docs/man2/
  78
  79 Specifications:
  80
  81 * 4.0: http://www.opengl.org/registry/doc/glspec40.core.20100311.pdf
  82 * 3.3: http://www.opengl.org/registry/doc/glspec33.core.20100311.withchanges.pdf
  83 * 2.1: http://www.opengl.org/documentation/specs/version2.1/glspec21.pdf
  84