summaryrefslogtreecommitdiffstats
path: root/fastlib/INSTALL
diff options
context:
space:
mode:
authorJon Bratseth <bratseth@yahoo-inc.com>2016-06-15 23:09:44 +0200
committerJon Bratseth <bratseth@yahoo-inc.com>2016-06-15 23:09:44 +0200
commit72231250ed81e10d66bfe70701e64fa5fe50f712 (patch)
tree2728bba1131a6f6e5bdf95afec7d7ff9358dac50 /fastlib/INSTALL
Publish
Diffstat (limited to 'fastlib/INSTALL')
-rw-r--r--fastlib/INSTALL62
1 files changed, 62 insertions, 0 deletions
diff --git a/fastlib/INSTALL b/fastlib/INSTALL
new file mode 100644
index 00000000000..501c4adf550
--- /dev/null
+++ b/fastlib/INSTALL
@@ -0,0 +1,62 @@
+**********************************************************************
+** FastLib Build and Installation Guide **
+**********************************************************************
+
+
+----------------------------------------------------------------------
+
+How do I build and install the C++ library?
+
+ cd src/cpp
+ ./configure --fastos-dir <full path to fastos> [--help | <options>]
+ make -s bootstrap
+ make -s install
+
+The default install directory is '../..' (relative to the src/cpp
+directory). This means that the library file will be installed in
+../../lib/ and the include files in ../../include/fastlib/.
+To override the default install directory, use the configure option
+'--install-dir'. Try './configure --fastos-dir <fastosdir> --help'
+for all available options.
+
+Support for additional functionality is available when configuring
+with --libxml2-dir <full path to libxml2>.
+The XML include files must have been installed in
+<libxml2-dir>/includes/libxml2/libxml
+The XML library must have been installed as
+<libxml2-dir>/lib/libxml2.a (or xml2.a on Windows)
+
+
+----------------------------------------------------------------------
+
+What kind of make targets are available, and what do they do?
+
+make depend - generate make-dependancy information
+make makefiles - generate makefiles for all modules
+make clean - delete all intermediate and output files
+make cleandir - does 'make clean' + deletes depend info
+make install - install the library and include files
+ to location $(INSTALLDIR)
+make kdoc - generate kdoc documentation
+make doxygen - generate doxygen documentation
+make bootstrap - (recommended build target) does:
+ make cleandir
+ make depend
+ make makefiles
+ make
+make tests - Compiles test programs, and runs them.
+ If a test program fails to compile or run,
+ the make process is stopped.
+ Please run 'make tests' after changing fastlib code
+ to ensure you have not broken anything.
+
+----------------------------------------------------------------------
+
+
+
+
+
+
+
+
+