[Kst] branches/work/kst/2.0.0-beta3/kst

[Barth Netterfield]

SVN commit 1035822 by netterfield:

Improved install instructions relevant for packagers.


 M  +38 -21    INSTALL  


--- branches/work/kst/2.0.0-beta3/kst/INSTALL #1035821:1035822
@@ -10,30 +10,34 @@
 3. Optionally update your ./config.pri (you probably don't need to do this).
 
 Globally installed build/install:
-1-3 above
-4. ./install-kst [release|debug [INSTALL_PREFIX [INSTALL_LIBDIR [OUTPUT_DIR]]]]
+Follow Linux build steps 1-3 (Preliminaries)
+4. ./install-kst [release|debug [INSTALL_PREFIX [INSTALL_LIBDIR]]]
 5. kst2
 
 Locally installed debug build:
-1-3 above
+Follow Linux build steps 1-3 (Preliminaries)
 4. ./build-kst 
 5. ./run-kst
 kst2 will be installed into ./build
 
+Create a package staged in /tmp/package/ for later installation in /usr:
+Follow Linux build steps 1-3 (Preliminaries)
+4. ./install-kst release /tmp/package/usr
 
 Command line options for install-kst (all optional)
     INSTALL_PREFIX - Installation location - Defaults to '/usr'
     INSTALL_LIBDIR - Library Installation Directory name - Defaults to 'lib'
-    release        - optimized build (eg, -O2) for release: this is the default
-    debug          - debug mode rather than release mode (eg, -g, no optimizations)
+    release        - optimized build (eg, -O2) for release (default)
+    debug          - debug build (eg, -g, no optimizations)
 
 Note:  It is recommended that all installable builds be "release", since
   release mode does not set the RPATH directories.  Setting RPATH can
   result in a security hole.  The default for ./install-kst is release
-Note: build-kst and install-kst both build in ./build, so ./build should be [re-]moved 
-  before running ./install-kst if a debug build from ./build-kst already exists.
-Note: installation likely requires root privilidges.  You can separate the build and install
-  steps (only if you really want to) by, eg:
+Note: build-kst and install-kst both build in ./build, so ./build should
+  be [re-]moved before running ./install-kst if a debug build from
+  ./build-kst already exists.
+Note: installation likely requires root privilidges.  You can separate the
+  build and install steps (only if you really want to) by, eg:
     ./build-kst release
     sudo ./install-kst release
 
@@ -60,7 +64,8 @@
 #0.  Not currently supported due to lack of a mac.  We'd love some help here!
 #1.  Same as the steps for Linux with some modifications required.
 #2.  The qmake command line needs to be updated to include -spec macx-g++.
-#3.  An error has been observed compiling view.cpp, view.h may need to be updated to change QXmlStreamWriter to QCoreXmlStreamWriter on line 45.
+#3.  An error has been observed compiling view.cpp, view.h may need to be
+     updated to change QXmlStreamWriter to QCoreXmlStreamWriter on line 45.
 
 
 *********************************************
@@ -77,11 +82,14 @@
 The following methods are not being activly tested, but might work.
 Windows using mingw
 
-Note:  This process must be done using the windows shell directly.  It cannot be done within cygwin or msys and neither can be included in the path.
+Note:  This process must be done using the windows shell directly.  It
+       cannot be done within cygwin or msys and neither can be included
+       in the path.
 
 1. Download or otherwise install Qt 4.5 or greater.
 2. Update environment variables for build.
-  a. This can be done using the Qt command line as installed in the Qt Creator bundle.
+  a. This can be done using the Qt command line as installed in the
+     Qt Creator bundle.
   b. This can be done using qtvars.bat generated by Qt and included below.
   c. This can be done manually following these steps.
     i. Make sure your QTDIR is set to that Qt installation.
@@ -91,7 +99,9 @@
 4. qmake -r ../kst.pro
 5. mingw32-make
 
-Notes:  Be careful to ensure there's nothing else in path that might interfere.  Cygwin, msys and various other things all have individual make and sh executables that are slightly incompatible.
+Notes:  Be careful to ensure there's nothing else in path that might
+        interfere.  Cygwin, msys and various other things all have
+        individual make and sh executables that are slightly incompatible.
 
 qtvars.bat - mingw - Update directories to match machine configuration.
 
@@ -117,24 +127,30 @@
 -------------------------------------------------------------
 Windows using Visual Studio
 
-Note:  This has only been build using Visual Studio & Cygwin.  The following steps
-are used on the current Windows build machine used for testing, but may vary.
+Note:  This has only been build using Visual Studio & Cygwin.  The following
+       steps are used on the current Windows build machine used for testing,
+       but may vary.
 
 1. Download or otherwise install Qt 4.5 or greater.
 2. Make sure your QTDIR is set to that Qt installation.
 3. Make sure your ./config.pri has the appropriate settings for you machine.
-4. Start up Cygwin's bash shell - Required due to command line length limit in cmd.exe.
-4a. Setup environment variables in Cygwin to link against Visual Studio - See qtvars.bat at end of file. It can be run as qtvars.bat vsbash to setup variables and start the shell.
+4. Start up Cygwin's bash shell - Required due to command line length limit
+   in cmd.exe.
+4a.Setup environment variables in Cygwin to link against Visual Studio -
+   See qtvars.bat at end of file. It can be run as qtvars.bat vsbash to
+   setup variables and start the shell.
 5. mkdir build && cd build
 6. qmake -r ../kst.pro
 7. nmake
-7a.  If an error occurs, you may need to update Makefile.debug and replace "CXX  = @echo compiling $< && cl" with "CXX=cl"
+7a.If an error occurs, you may need to update Makefile.debug and replace
+   "CXX  = @echo compiling $< && cl" with "CXX=cl"
 7b.  If libkstapp fails to build the following steps should circumvent the error.
   1) run nmake >makelog
   2) locate the cl.exe command line including application.cpp and copy it
   3) Replace all \ with \\ in the command
-  4) Starting in the build directory, cd src\libkstapp, paste the command line, return to the build directory
-  4) rerun nmake.
+  4) Starting in the build directory, cd src\libkstapp, paste the command
+     line, return to the build directory
+  5) rerun nmake.
 8. ../run-kst
 
 
@@ -176,6 +192,7 @@
 No installer exists for windows currently.  To distribute / move locations.
 
 1. Create kst/bin and kst/plugin directories
-2. Copy kst.exe mingwm10.dll QtCore4.dll QtGui4.dll QtOpenGL4.dll QtSvg4.dll QtXml4.dll into kst/bin
+2. Copy kst.exe mingwm10.dll QtCore4.dll QtGui4.dll QtOpenGL4.dll QtSvg4.dll
+   QtXml4.dll into kst/bin
 3. Copy DataSource and DataObject Plugins to kst/plugin
 4. Package kst directory or use from this location.