INSTALL.txt

   1 Building J-Ben
   2 ==============
   3
   4 Dependencies:
   5
   6 J-Ben is dependent on (at least) two different development packages.
   7 * wxWidgets: J-Ben is being developed using wxWidgets 2.8.7.  It may and
   8   probably will work on slightly earlier versions, but I can't guarantee
   9   everything will work right.
  10 * The Boost Libraries: J-Ben should work with boost 1.34.1 or later.
  11
  12 If building for Linux, you will also need a development package for:
  13 * GTK+ 2: Tested using debian's libgtk2.0-dev package, version 2.12.1-1
  14
  15 Linux users:
  16
  17 Ensure you have the development packages for libboost and
  18 wxWidgets installed.  Then, just "make".  There is no "make install" at this
  19 time, sorry.  It will be added later.
  20
  21 Windows users:
  22
  23 While Linux building should be mostly non-problematic, the Windows
  24 build support is NOT robust.  It's designed specifically for use with MinGW
  25 without the MSYS environment.
  26
  27 If you want to give it a try, do the following:
  28 * Ensure mingw's bin folder is in your path
  29 * Install the coreutils and sed packages from the gnuwin32 project.
  30   This means the binaries and the dependencies.  You'll probably come across
  31   duplicate DLLs while unzipping these packages.  This should be okay, just
  32   keep the newer copy of any duplicate DLLs.
  33 * Make sure the coreutils/sed binaries are in your path.
  34 * Change the 4 variables in the "WINDOWS-SPECIFIC" below as needed
  35 * build using the following command:
  36   mingw32-make PLATFORM=windows BUILD=<release|debug|profile>
  37
  38 Expert: Canadian Cross Linux->Windows builds
  39 (Most people can safely skip this section.)
  40
  41 To attempt a "canadian cross" build, run:
  42    make CANUCK=1 PLATFORM=windows BUILD=<release|debug|profile> \
  43    CC=<cross-compiling gcc> CXX=<cross-compiling g++>
  44 (This has not yet been tested; I'm working on it!)
  45
  46
  47 Installing J-Ben
  48 ================
  49
  50 Currently there is no proper installer mechanism for the program; I've been
  51 mostly focused on the program itself since it is still quite lacking in several
  52 areas.  I will address installation at a future date.
  53
  54 For Windows users, adding a start menu shortcut should be a trivial affair, if
  55 desired.  Just do it yourself.
  56
  57 For Linux users, you could add the program's directory to your path via your
  58 ~/.bashrc file, or you could make a script like the following:
  59
  60 #!/bin/sh
  61 cd <path_to_jben>
  62 ./jben
  63
  64 Put that in /usr/bin or similar, do a chmod +x on it and that'll make things
  65 simpler.
  66
  67
  68 Problems
  69 ========
  70
  71 If you have any issues building J-Ben, please contact the author.  Contact
  72 information is in README.txt.