Add documentation for SPV file format.

[pspp] / README.Git

diff --git a/README.Git b/README.Git
index ce9fa9ddaa2d4de1f6a1e36959317d5b6af6b72e..c314e73f423a220e11e3dea0fe87b9e1ff4f9897 100644 (file)
--- a/README.Git
+++ b/README.Git
@@ -23,6 +23,8 @@ following:
 
        * Texinfo 4.7 or later, to build the documentation.
 
 
        * Texinfo 4.7 or later, to build the documentation.
 

+       * Gimp --  2.8.2 is known to work
+

 After you install PSPP's prerequisites, you must obtain a copy of
 Gnulib, then bootstrap the tree, as described in the sections below.
 After that, you may follow the procedure described in INSTALL.
 After you install PSPP's prerequisites, you must obtain a copy of
 Gnulib, then bootstrap the tree, as described in the sections below.
 After that, you may follow the procedure described in INSTALL.


@@ -34,15 +36,18 @@ This version of PSPP should work with the Gnulib commit shown below.
 Gnulib does not maintain a stable API or ABI, so it is possible that
 PSPP will not work with older or newer versions of Gnulib.
 
 Gnulib does not maintain a stable API or ABI, so it is possible that
 PSPP will not work with older or newer versions of Gnulib.
 

-    commit 9de26050ef8a950fd62ebadeeab2eb7505631028
-    Author: Eric Blake <ebb9@byu.net>
-    Date:   Wed Sep 2 17:06:43 2009 -0600
+       commit c5c4f53b31f1ad04f4033a6124120ffec9257847
+       Author: Pádraig Brady <P@draigBrady.com>
+       Date:   Sat Dec 6 01:14:02 2014 +0000
+
+           vasnprintf: fix potential use after free

 
 

-       errno: use consistently
+           * lib/vasnprintf.c (VASNPRINTF): Fix free-memory read,
+           flagged by clang-analyzer 3.4.2.

 
 To clone Gnulib into a directory named "gnulib" using Git, and then
 check out this particular commit, run these commands:
 
 To clone Gnulib into a directory named "gnulib" using Git, and then
 check out this particular commit, run these commands:

-       git://git.savannah.gnu.org/gnulib.git gnulib
+       git clone git://git.savannah.gnu.org/gnulib.git gnulib

        cd gnulib
        git checkout $COMMIT
 where $COMMIT should be replaced by the commit number listed above
        cd gnulib
        git checkout $COMMIT
 where $COMMIT should be replaced by the commit number listed above


@@ -74,3 +79,58 @@ Once PSPP is built, you may run its self-tests with:
        make check
 or for a more thorough test:
        make distcheck
        make check
 or for a more thorough test:
        make distcheck

+
+Glade UI Design
+---------------
+
+The ui files in src/ui/gui may be viewed (maybe changed) with Glade. For this
+you need
+
+       * libgladeui 2.0 or later
+
+Then you need to run
+
+        configure --with-gui-tools
+       make
+       make install
+
+psppire uses some self defined widgets. To use glade these widgets have
+to be announced to glade such that you can view the interface.
+The install process will install the psppire glade library, icons and
+psppire.xml files in the appropiate system locations. You cannot override
+this with --prefix. After that you can run "glade" and open the ui files.
+
+Building from git on Mac OS
+---------------------------
+
+You can build on MacOS in the macports environment. After installing all
+required packages to resolve library dependencies and autotools e.t.c, you
+run make -f Smake as described above.
+
+The macports system provides the libraries and header files in a separate
+location from the MacOS system libraries. The typical locations are
+
+Libraries: /opt/local/lib
+Headers:   /opt/local/include
+
+pspp under macports will be linked against the macports libraries. The configure
+script has to be informed about the library and header locations. Assume the following
+directory structure for an out of tree build:
+
+~/mypspp
+  |----pspp    (This is the pspp git directory)
+  |----install (The install location containing also ui files for psppire)
+  |----build   (The build directory)
+  |----gnulib  (The gnulib directory as described above)
+
+Then you can build with the following commands:
+
+    cd ~/mypspp/pspp
+    make -f Smake
+    cd ../build
+    ../pspp/configure --prefix=/Users/USER/mypspp/install \
+                  LDFLAGS=-L/opt/local/lib \
+                 CPPFLAGS=-I/opt/local/include
+    make
+    make install
+    ../install/bin/psppire (If everything worked, you should see psppire...)