From: Kevin M. Rosenberg <kevin@rosenberg.net>
Date: Mon, 12 Feb 2018 23:43:12 +0000 (-0700)
Subject: Update install directions
X-Git-Url: http://git.kpe.io/?p=snark14.git;a=commitdiff_plain;h=56631741880b8ee30adb3f0579a4495fcc7e1278

Update install directions
---

diff --git a/INSTALL b/INSTALL
index cfc0c31..3f44e16 100644
--- a/INSTALL
+++ b/INSTALL
@@ -1,12 +1,32 @@
-BUILDING SNARK14
+Installing SNARK14
+==================
 
-To build snark14 run the command:
+Install Prerequisites
+---------------------
+
+1. Install prerequisite packages. Note this version of SNARK14 has
+been ported to Xerces 3. For Debian or Ubuntu, the required packages
+can be installed with the following
+
+$ sudo apt install build-essential libxerces-c-dev wget
+
+2. Run the following command
+
+$ doc/install-qt3.sh
+
+to download and install QT3 into the /usr/local/qt directory which is
+required to build the graphical tools.
 
-$ make
 
-_________________
+Building SNARK14
+----------------
 
-The software will create the directories
+Run the commands
+
+$ make
+$ make install
+
+which will create and populate the directories of
 
 bin
 build
@@ -16,13 +36,10 @@ and it will install the SNARK14 in the following directory
 
 bin/snark14
 
-with the following libraries
+and install the binary in /usr/local/bin and the following shared
+libraries in /usr/local/lib:
 
 lib/libDIGFile.so
 lib/libDIGFileSnark.so
 lib/libDIGRand.so
-
-The building process assumes an installation of the original
-SNARK14 and XERCES 2.6.1 in the directory
-
-/usr/local/snark14
+lib/libsnark14.so
diff --git a/build-debian.sh b/build-debian.sh
deleted file mode 100755
index 0b6950e..0000000
--- a/build-debian.sh
+++ /dev/null
@@ -1,33 +0,0 @@
-#!/bin/bash
-
-echo "SNARK14m Debian/Ubuntu build"
-echo "Kevin Rosenberg <kevin@rosenberg.net>"
-
-echo "Install required packages"
-sudo apt install build-essential libxerces-c-dev wget
-     
-echo "Download and patch QT3"
-wget https://download.qt.io/archive/qt/3/qt-x11-free-3.3.8b.tar.gz
-tar xzf qt-x11-free-3.3.8b.tar.gz
-cd qt-x11-free-3.3.8b
-
-# Add missing '#include <stddef.h>' to files using ptrdiff_h
-cd include
-for i in `grep -l ptrdiff_t *.h`; do
-      echo "#include <stddef.h>" > tmp
-      cat $i >> tmp
-      mv tmp $i
-done
-cd ..
-
-echo "Build QT3"
-echo "yes" | ./configure && make
-cd ..
-
-echo "Make shared libraries findable"
-sudo mv qt-x11-free-3.3.8b /usr/local/qt3
-echo "/usr/local/qt3/lib" > qt3.conf
-sudo mv qt3.conf /etc/ld.so.conf.d/.
-sudo ldconfig
-
-
diff --git a/doc/install-qt3.sh b/doc/install-qt3.sh
new file mode 100755
index 0000000..8110b1c
--- /dev/null
+++ b/doc/install-qt3.sh
@@ -0,0 +1,32 @@
+#!/bin/bash
+
+echo "SNARK14m Debian/Ubuntu build"
+echo "Kevin Rosenberg <kevin@rosenberg.net>"
+
+echo "Install required packages"
+     
+echo "Download and patch QT3"
+wget https://download.qt.io/archive/qt/3/qt-x11-free-3.3.8b.tar.gz
+tar xzf qt-x11-free-3.3.8b.tar.gz
+cd qt-x11-free-3.3.8b
+
+# Add missing '#include <stddef.h>' to files using ptrdiff_h
+cd include
+for i in `grep -l ptrdiff_t *.h`; do
+      echo "#include <stddef.h>" > tmp
+      cat $i >> tmp
+      mv tmp $i
+done
+cd ..
+
+echo "Build QT3"
+echo "yes" | ./configure && make
+cd ..
+
+echo "Make shared libraries findable"
+sudo mv qt-x11-free-3.3.8b /usr/local/qt3
+echo "/usr/local/qt3/lib" > qt3.conf
+sudo mv qt3.conf /etc/ld.so.conf.d/.
+sudo ldconfig
+
+