Skip to content

Commit

Permalink
updates to README and INSTALL files
Browse files Browse the repository at this point in the history
  • Loading branch information
kburtch committed Jan 8, 2025
1 parent cda25a1 commit a50a629
Show file tree
Hide file tree
Showing 2 changed files with 38 additions and 13 deletions.
37 changes: 36 additions & 1 deletion INSTALL
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.

Expand Down Expand Up @@ -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.)

Expand All @@ -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
Expand Down Expand Up @@ -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
Expand Down
14 changes: 2 additions & 12 deletions README
Original file line number Diff line number Diff line change
Expand Up @@ -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!"

0 comments on commit a50a629

Please sign in to comment.