Commit 3d95ac91 authored by thomas.forbriger's avatar thomas.forbriger

[TASK][DOC] (seitosh): provide basic installation instructions

This is a legacy commit from before 2015-03-01.
It may be incomplete as well as inconsistent.
See COPYING.legacy and README.history for details.

Installation instructions should be completely reorganized, making use of the
gitlab project's wiki too. As first step, this rudimentary file must serve as
a makeshift.
parent 437f1ca5
How to install seitosh
======================
The documentation of this repository is not yet tailored to support
direct installation, although repective tools are available.
Available README files are provided with snapshop packages
(tar-balls) in mind. Nevertheless they provide all necessary
information.
Recommended steps to take
-------------------------
1. Read [src/pakete/README.1st](src/pakete/README.1st)
which is written with tar-balls in mind.
You will not use the shell script *install.sh* but
its appropriate counterpart
[src/compile.sh](src/compile.sh).
[README.1st](src/pakete/README.1st)
provides a reasonable overview.
2. Read [src/pakete/README.compile](src/pakete/README.compile)
which provides a thourough overview over requirements and
environment variables expected by Makefiles.
3. Read [src/README.pgplot](src/README.pgplot)
to understand how to install the PGPLOT library, which is
required by programs producing graphical output.
4. Once you feel ready (having installed all required compilers
and external libaries, having set all expected environment
variable) change to directory [src](src) and use the shell
script [src/compile.sh](src/compile.sh) by issuing the
command
compile.sh install
Further resources of information
--------------------------------
* https://git.scc.kit.edu/Seitosh/Seitosh/wikis/home
is the wiki accompanying the repository
* http://gpitrsvn.gpi.uni-karlsruhe.de:8000/TFSoftware
is the predecessor of Seitosh
* http://gpitrsvn.gpi.uni-karlsruhe.de:8000/TFSoftware/wiki/docs/installation
discusses the installation procedure in detail
* http://gpitrsvn.gpi.uni-karlsruhe.de:8000/TFSoftware/wiki/docs/PGPLOT
describes the installation of the PGPLOT library
* http://gpitrsvn.gpi.uni-karlsruhe.de:8000/TFSoftware/wiki/docs/ProgramDirectory
is an incomplete directory of programs
* http://gpitrsvn.gpi.uni-karlsruhe.de:8000/TFSoftware/wiki/trunk
provides documentation for source-code subdirectories; however,
not all of them have been transferred to Seitosh and not all Seitosh
directories are mentioned there
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment