summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/Doxyfile2
-rwxr-xr-xdoc/QUICKSTART.ubuntu34
2 files changed, 35 insertions, 1 deletions
diff --git a/doc/Doxyfile b/doc/Doxyfile
index 49901f5..118e8b3 100644
--- a/doc/Doxyfile
+++ b/doc/Doxyfile
@@ -55,7 +55,7 @@ PROJECT_NAME = "The SWORD Project"
# This could be handy for archiving the generated documentation or
# if some version control system is used.
-PROJECT_NUMBER = "1.7.2"
+PROJECT_NUMBER = "1.7.3"
# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute)
# base path where the generated documentation will be put.
diff --git a/doc/QUICKSTART.ubuntu b/doc/QUICKSTART.ubuntu
new file mode 100755
index 0000000..23a7b5a
--- /dev/null
+++ b/doc/QUICKSTART.ubuntu
@@ -0,0 +1,34 @@
+#!/bin/sh
+# Quickstart (tested on Ubuntu versions 9.10-13.10)
+#
+# You should probably be able to also run this QUICKSTART
+
+# For a build of the latest code directly from source control:
+
+# From a fresh Ubuntu installation, this should get you all the necessary
+# packages for a full featured install of the SWORD libs, compile and install
+# the engine, install a modules, and test with a simple command line tool:
+
+# install necessary packages for all features of SWORD to be enabled
+sudo apt-get install autoconf autogen automake subversion make g++ libtool zlib1g-dev libicu-dev libclucene-dev libcurl4-openssl-dev
+
+# checkout and build the source tree
+svn co https://crosswire.org/svn/sword/trunk sword
+cd sword
+./autogen.sh
+
+# you may want to review and edit usrinst.sh to see if the default options
+# meet your needs
+./usrinst.sh
+make -j
+sudo make install
+sudo make install_config
+
+# install a module
+sudo installmgr -init -sc -r CrossWire -ri CrossWire KJV
+
+# build and test a simple command line example tool
+cd examples/cmdline
+make
+./lookup KJV jn.3.16
+