From d6161b2d5d674b3c463c5d9c343dcb5a5a15144f Mon Sep 17 00:00:00 2001 From: Paul Goins Date: Thu, 16 Dec 2010 00:00:38 +0900 Subject: [PATCH] Updated documentation. --- INSTALL.txt | 74 +++++++++++++++++++++++++++++++++++++++------------- INSTALL_autoconf.txt | 52 ++++++++---------------------------- 2 files changed, 67 insertions(+), 59 deletions(-) rewrite INSTALL.txt (98%) rewrite INSTALL_autoconf.txt (63%) diff --git a/INSTALL.txt b/INSTALL.txt dissimilarity index 98% index 9877876..3c81d4f 100644 --- a/INSTALL.txt +++ b/INSTALL.txt @@ -1,18 +1,56 @@ -STUB. This still needs to be fleshed out... - - -Installation of J-Ben: - - python setup.py install - -Installation of jben_kpengine: - - - Compiling: ./configure && make - Installing: Not yet standardized. - Windows: place kpengine folder at same level as jben package. - Unix: not yet integrated; source hacking required - -Running the program: - - python -m jben.main +POSIX build instructions (Linux, BSD, etc.) +=========================================== + +J-Ben uses the standard "./configure; make; make install" process. +Just try the following: + + ./configure && make + make install + +To run the program: + + python -m jben.main + +"jben_launcher.py" *may* also work, but it has not yet been tested. + + +Windows build instructions +========================== + +Prerequisites: + +1. MinGW, MSys, and the autotools. (If you don't have these, go to + http://sourceforge.net/projects/mingw/files/, and download the + "latest version": mingw-get-inst-XXXXXXXX.exe.) + +2. GTK+ development libraries. Get the GTK+ development bundle from + www.gtk.org. Unzip it somewhere and insert its bin folder into + your PATH (preferably at the beginning of the PATH to avoid + conflicts with other libraries). + +3. Inno Setup, for creating the installer. + +Instructions are as follows: + +1. Do the basic build: + + CFLAGS=-mwindows ./configure && make + +2. Make the py2exe executable: + + cd python; setup.py py2exe + +3. Run the Inno Setup jben.iss file (update as necessary for your environment) + +4. Install the generated executable + +This process has been tested on Windows 7 with: + +- autoconf 2.67 +- automake 1.11.1 +- py2exe 0.6.9 +- Python 2.7 +- GTK bundle 2.22.0-20101016_win32 +- pygtk 2.22.0 +- pygobject 2.26.0 +- pycairo 1.8.10 diff --git a/INSTALL_autoconf.txt b/INSTALL_autoconf.txt dissimilarity index 63% index 1ba2592..8c45892 100644 --- a/INSTALL_autoconf.txt +++ b/INSTALL_autoconf.txt @@ -1,41 +1,11 @@ -J-Ben uses autoconf and automake for building the bundled "kpengine" -application. This document is intended for those who are not familiar -with using the autotools directly. - -If the bundled application does not contain a "configure" script (for -example, if pulled directly from git), the following should create the -needed files: - - autoreconf -i - -Afterwards: - -If running on POSIX (Linux, BSD, etc.): - - ./configure && make - make install - -If running on Windows, it's a bit more complicated: - - Do the basic build: - - CFLAGS=-mwindows ./configure && make - - Make the py2exe executable: - - cd python; setup.py py2exe - - Run the Inno Setup jben.iss file (update as necessary for your environment) - - Install the generated executable - -Tested on Windows with: - -- autoconf 2.67 -- automake 1.11.1 -- py2exe 0.6.9 -- Python 2.7 -- GTK bundle 2.22.0-20101016_win32 -- pygtk 2.22.0 -- pygobject 2.26.0 -- pycairo 1.8.10 +J-Ben uses autoconf and automake for building the bundled "kpengine" +application. This document is intended for those who are not familiar +with using the autotools directly. + +If the bundled application does not contain a "configure" script (for +example, if pulled directly from git), the following should create the +needed files: + + autoreconf -i + +The remainder of installation instructions are in INSTALL.txt. -- 2.11.4.GIT