From a50a629126480badb86880c77b6894bdd5d4dfc6 Mon Sep 17 00:00:00 2001 From: Ken Burtch Date: Wed, 8 Jan 2025 14:56:22 -0500 Subject: [PATCH] updates to README and INSTALL files --- INSTALL | 37 ++++++++++++++++++++++++++++++++++++- README | 14 ++------------ 2 files changed, 38 insertions(+), 13 deletions(-) diff --git a/INSTALL b/INSTALL index eafd461d..e8e95d32 100644 --- a/INSTALL +++ b/INSTALL @@ -32,6 +32,22 @@ standard C libraries for your operating system. Please contribute new os_bindings files to the SparForte project. +BINARY DISTRIBUTIONS vs. SOURCE CODE + +The binary versions are created while testing SparForte before release. +They are built for specific version of specific Operating Systems. You +will need to run the provision.sh script to install all the library +dependencies for your operating systems. + +The binary distributions should containt the spar binary and the +SparForte manual in the doc directory and sample scripts in the examples +directory. + +The source code file has the source code in Ada, C and shell scripts, +along with the SparForte manual and sample scripts. You will need to +build SparForte from the source files to use it. + + REQUIREMENTS We have attempted to avoid re-inventing existing functionality wherever @@ -73,6 +89,12 @@ The following software packages are required for SparForte: * SDL (Simple DirectMedia Layer) library and SDL_image + * GNU locate is optional. The configure script will fallback to using + the "find" command. + + +DEPENDENCIES + These may not be installed on your operating system, or some components may be missing. How you install these depends on your operating system. @@ -112,7 +134,8 @@ The following software packages are required for SparForte: $ apt-get install postgresql-server-dev-all $ apt-get install libgstreamer0.10-dev - Update the locate database: Debian uses a static Ada Run-Time file so SparForte + If you GNU locate is installed, update the locate database: + Debian uses a static Ada Run-Time file so SparForte will need to use locate instead of ldconfig to find it. (Running updatedb is safe even if this was not true.) @@ -138,6 +161,7 @@ The following software packages are required for SparForte: $ sh configure $ make + INSTALLATION SparForte has a language test suite to verify builds and the sample @@ -269,6 +293,17 @@ Type "gmake help" for a list of all options. There are more options in the src directory makefile. +LOGIN SHELL + +SparForte will run as a login shell if you place it in the /etc/passwd +file accordingly. Alternatively, change /etc/shells to allow users to +select spar as a shell with chsh. You will need to be the superuser to +copy or edit these files. + +You can run SparForte in login shell mode without making it your login +shell by running it using the "--login" (or "-l") command option. + + INSTALLING FOR WEB TEMPLATES SparForte can run as a CGI program. The exact requirements depends on diff --git a/README b/README index 945e7edb..22622d1d 100644 --- a/README +++ b/README @@ -25,18 +25,8 @@ APQ is released under the ACL or GPL licence. Installation -If you have downloaded the binary version, you should have the spar -binary and the SparForte manual in the doc directory and sample scripts in -the examples directory. - -To install SparForte as your login shell, copy the "spar" file to the -/usr/local/bin directory (or type "make install" to do this for you). -Then change the /etc/passwd file accordingly. Alternatively, change -/etc/shells to allow users to select spar as a shell with chsh. -You will need to be the superuser to copy or edit these files. - -If you have downloaded the SparForte sources, the INSTALL file contains -instructions for compiling the sources. +INSTALL has information on how to install SparForte. + "Have a lot of fun!"