Permalink
Browse files

Updated documents with new refactored build scripts and for RC27 rele…

…ase.
  • Loading branch information...
bparsons-sgl committed Oct 16, 2015
1 parent 9e8acd4 commit fc4ab526d27dfbd5c85c40427a53848f671a121a
File renamed without changes.
View
@@ -136,7 +136,7 @@ endif()
set( CPACK_PACKAGE_DESCRIPTION_SUMMARY "GPSTk libraries and applications for GNSS processing.")
set( CPACK_PACKAGE_VENDOR "ARL:UT SGL" )
set( CPACK_PACKAGE_CONTACT "Bryan Parsons" )
set( CPACK_PACKAGE_DESCRIPTION_FILE "${CMAKE_CURRENT_SOURCE_DIR}/README.txt" )
set( CPACK_PACKAGE_DESCRIPTION_FILE "${CMAKE_CURRENT_SOURCE_DIR}/README.md" )
set( CPACK_PACKAGE_VERSION_MAJOR "${GPSTK_VERSION_MAJOR}" )
set( CPACK_PACKAGE_VERSION_MINOR "${GPSTK_VERSION_MINOR}" )
set( CPACK_PACKAGE_VERSION_PATCH "${GPSTK_VERSION_PATCH}" )
View
@@ -10,7 +10,7 @@ cmake_minimum_required( VERSION 2.8.5 )
project( GPSTK )
set( GPSTK_VERSION_MAJOR "2" )
set( GPSTK_VERSION_MINOR "6" )
set( GPSTK_VERSION_MINOR "7" )
set( GPSTK_VERSION_PATCH "0" )
set( GPSTK_VERSION "${GPSTK_VERSION_MAJOR}.${GPSTK_VERSION_MINOR}.${GPSTK_VERSION_PATCH}" )
File renamed without changes.
File renamed without changes.
@@ -1,3 +1,19 @@
#################################################
Version 2.7 Friday, October 16, 2015
General modifications
---------------------
Modifications by Author
---------------------
#################################################
View
@@ -88,7 +88,7 @@ will need to export the library install path if you install to a
non-standard path. The build script will test your paths to and warn
you if your installs cannot be found.
Typical system installs will look like this:
Typical builds (no install) will look like this:
$ ./build.sh -e
@@ -98,17 +98,17 @@ Typical user installs will look like this:
$ ./build.sh -eu
Typical test install will look like this:
Typical test and install will look like this:
$ export LD_LIBRARY_PATH=/tmp/test/lib:$LD_LIBRARY_PATH
$ ./build.sh -et -i /tmp/test
Typical install and binary tarball package will look like this:
Typical install and binary tarball package (in build folder) will look like this:
$ export LD_LIBRARY_PATH=/tmp/test/lib:$LD_LIBRARY_PATH
$ ./build.sh -eg
$ ./build.sh -ep -i /tmp/test
UNIX-like Environment: Manual Build, Install, and Package:
@@ -175,8 +175,7 @@ commands instead of build.sh:
UNIX-like Environment: Python Bindings Build and Install:
---------------------------------------------------------
The build.sh script must be used to build and install the GPSTk Python Bindings. See the script help for details
on those parameters:
As the build.sh script builds the Python Bindings by default:
$ cd $gpstk_root
@@ -189,15 +188,15 @@ you if your installs cannot be found.
Typical system installs with python bindings will look like this:
$ ./build.sh -ep
$ ./build.sh -e
Typical user installs with python bindings will look like this:
$ ./build.sh -eup
$ ./build.sh -eu
Typical user installs with python bindings and documentation will look like this:
$ ./build.sh -eupd
$ ./build.sh -eud
OSX and XCode: Building and Installing with CMake:
File renamed without changes.
View
File renamed without changes.
View
File renamed without changes.
View
@@ -163,9 +163,9 @@ To build and install the C++ library and applications on POSIX platforms:
To build and install the python bindings, you have two options:
* automated: run the build.sh, minimally with the "-p" flag.
* automated: python bindings automatically build with the build.sh. Use -P for install.
* manual build: see build.sh for examples on calling cmake and swig
* manual install: use the setup.py script in the install_package path. See $GPSTK/swig/install_package/INSTALL.txt for more details
* manual install:
Testing:
View
@@ -20,7 +20,7 @@ Introduction:
As an open source project, the source of the GPSTk is subject to intermittent updates, contributions,
and corrections. The GPSTk library testing process has been redesigned to build confidence in the
functionality of the library. Testing within the GPSTk library is designed with three distinct goals
functionality of the library. Testing within the GPSTk library is designed with the following distinct goals
in mind:
Testing is repeatable with a low amount of effort.
@@ -40,17 +40,15 @@ There are two main methods for running the GPSTk test suite in a UNIX-like Envir
Automated build and test utilizing the build.sh script
Manual build and test utilizing CMake and CTest
NOTE: The automated build provides testing metrics that are not available through the manual build.
UNIX-like Environment: Automated Build and Test:
------------------------------------------------
If you prefer automation, run the GPSTk script.
If you prefer automation, run the build.sh script.
Typical test build without install will look like this:
$ ./build.sh -bet
$ ./build.sh -et
Typical test build with install will look like this:
@@ -60,6 +58,11 @@ Typical test build with install will look like this:
$ ./build.sh -et -i /tmp/test
To run a detailed test report after after build, install, and test:
$ ./test-report.sh
UNIX-like Environment: Manual Build and Test:
---------------------------------------------
@@ -90,6 +93,12 @@ To manually build and test the GPSTk, follow the following steps:
$ ctest
5. To run a test report:
$ cd $gpstk_root
$ ./test-report.sh
OSX and XCode: Testing Procedure:
---------------------------------
View
@@ -100,13 +100,13 @@ file( COPY ${INSTALL_PACKAGE_SOURCE}/ DESTINATION ${INSTALL_PACKAGE_PATH} PATTER
# CONFIGURATION: Copy meta files.txt
set( METAFILES "" ) # for a single set() command, just ";" delimiter between entries in the list
list( APPEND METAFILES "${CMAKE_SOURCE_DIR}/AUTHORS.txt" )
list( APPEND METAFILES "${CMAKE_SOURCE_DIR}/COPYING.txt" )
list( APPEND METAFILES "${CMAKE_SOURCE_DIR}/COPYING.LESSER.txt" )
list( APPEND METAFILES "${CMAKE_SOURCE_DIR}/ChangeLog.txt" )
list( APPEND METAFILES "${CMAKE_SOURCE_DIR}/INSTALL.txt" )
list( APPEND METAFILES "${CMAKE_SOURCE_DIR}/NEWS.txt" )
list( APPEND METAFILES "${CMAKE_SOURCE_DIR}/README.txt" )
list( APPEND METAFILES "${CMAKE_SOURCE_DIR}/AUTHORS.md" )
list( APPEND METAFILES "${CMAKE_SOURCE_DIR}/COPYING.md" )
list( APPEND METAFILES "${CMAKE_SOURCE_DIR}/COPYING.LESSER.md" )
list( APPEND METAFILES "${CMAKE_SOURCE_DIR}/ChangeLog.md" )
list( APPEND METAFILES "${CMAKE_SOURCE_DIR}/INSTALL.md" )
list( APPEND METAFILES "${CMAKE_SOURCE_DIR}/NEWS.md" )
list( APPEND METAFILES "${CMAKE_SOURCE_DIR}/README.md" )
file( COPY ${METAFILES} DESTINATION ${INSTALL_PACKAGE_PATH} )
#--------------------------------------------

0 comments on commit fc4ab52

Please sign in to comment.