Commit ca18701d authored by thomas.forbriger's avatar thomas.forbriger
Browse files

[WP] (install): reorganize files in src

After abandoning the snapshot package mechanism, files in subdirectory src
have to be reorganized. Some of them are moved to directoty contrib in the
root of the repository.

In detail:
 - LICENSE.GPL  should live at the top level of the repository
 - GPLphrase    is required by a shell script gplphrase, which is not yet part
                of Seitosh; it better lives in contrib
 - Makefile.buildingblocks
                this is a collection of make rules useful to developers;
                it better lives in contrib
 - TFbashrc     is a template for users; it better lives in contrib
 - contrib/pgplot
                contains additional configuration files for PGPLOT
                it definitivly better lives in contrib
 - README.1st   was specifically written for snapshot packages and is obsolete
 - README.copying
                was specifically written for snapshot packages and is obsolete
 - README       was specifically written for TFSoftware and is obsolete
 - Makefile     was designed for the layout of subdirectory src, which is now
                abandoned; the file has become obsolete
parent d0452bbb
# this is <Makefile>
# ----------------------------------------------------------------------------
# $Id: $
#
# Copyright (c) 2014 by Thomas Forbriger (BFO Schiltach)
#
# provide a rule to open vim with the appropriate file index
#
# REVISIONS and CHANGES
# 11/01/2014 V1.0 Thomas Forbriger
#
# ============================================================================
#
all:
flist: $(filter-out %.bak,$(wildcard README* Makefile*)) \
TFbashrc GPLphrase LICENSE.GPL \
$(filter-out %.bak,$(wildcard pakete/README* pakete/Makefile*)) \
$(wildcard pakete/*.bashrc) $(wildcard pakete/*.sh *.sh) pakete/packagetest
echo $^ | tr ' ' '\n' | sort > $@
.PHONY: edit
edit: flist; vim $<
.PHONY: clean
clean: ;
-find . -name \*.bak | xargs --no-run-if-empty /bin/rm -v
-/bin/rm -vf flist
# ----- END OF Makefile -----
this is <README>
============================================================================
compiler language software
--------------------------
$Id$
============================================================================
Source code from TFSoftware repository is distributed in two ways:
1. Distribution through snapshot packages being distributed at
http://gpitrsvn.gpi.uni-karlsruhe.de:8000/TFSoftware/downloads
These packages come together with README files and an install.sh shell
script which can be used to compile and install the software.
2. Distribution through the subversion repository.
The code respository is only accessible for registered users. See
http://gpitrsvn.gpi.uni-karlsruhe.de:8000/TFSoftware/wiki
for more information on how to obtain and install the code.
Within the repository you should check
trunk/texts/README.licence_and_copyright
trunk/src/TFbashrc is a template for your shell configuration.
trunk/src/pakete/README.compile is written for users of snapshot packages
but may also be interesting for repository users.
----- END OF README -----
this is <README.1st>
============================================================================
General guide for published packages
------------------------------------
$Id$
============================================================================
The package you received is a snapshot taken from the TFSoftware subversion
repository. It is a snapshot of the code currently in use by TFSoftware users
and developers. Currently only basic support is provided for external users.
The snapshots usually come together with a shell script called install.sh
which will take care for appropriate default settings and correct order of
execution. By default, contents will be added only to subdirectories of the
location of install.sh.
For a first attempt just issue
install.sh
at the command prompt of your shell.
If you like to integrate the code into your local environment, you have to
choose some environment settings. For this advanced installation some guidance
is given below and in other README files. Please feel free to get into contact
with Thomas Forbriger (see below) if you have additional questions.
If you find this code useful for your purpose I would appreciate to receive a
note from you. If you feel able to provide bug fixes or improvements and
extensions to the code, please to not hesitate to send a patch. I will
consider to include it in the repository (with appropriate acknowledgements)
in order to make it available to other users.
Apart from the current file, the package usually should contain:
Package-specific files
----------------------
README.package:
Information concerning the package itself and the system on which
the package was built and tested.
install.sh: This shell script supports automatic installation of the packages.
It guesses the appropriate configuration and executes the
compilation and installation commands. It provides usage
information. Just execute install.sh to read more.
issue the make command, to compile and install the binary files
after environment variables have been set according to
README.compile.
install.bashrc:
Package specific configuration settings for install.sh
Makefile: The Makefiles in the source code subdirectories contain all
rules you need to compile the code. Information about the purpose
of the package, special considerations during installation and
dependencies to other packages are provided in README files or
are placed in the preamble of the Makefile.
Standard files (no package-specific content)
--------------------------------------------
README.compile:
The file contains general and detailed information regarding
required libraries, compilers, and utilities and regarding
environment settings which are usually expected by the Makefile.
README.dependencies:
A description of the chain of dependencies (which library depends
on which other).
TFbashrc: This is a template for your shell configuration. All settings are
disabled by default. The file is read by install.sh nevertheless
LICENSE.GPL:
Text of the GNU GENERAL PUBLIC LICENSE. The preamble of each file
of source code contains information regarding the license and the
copyright which apply to the individual file.
README.pgplot:
Packages requiring the PGPLOT graphics library, contain this file.
It contains a summary of steps necessary to install PGPLOT.
If you experience any problem, please contact:
--
| Dr. Thomas Forbriger e-mail: Thomas.Forbriger@kit.edu
| Observatorium Schiltach (BFO), Heubach 206, D-77709 Wolfach, Germany,
| Geophysikalisches Institut, Karlsruher Institut für Technologie (KIT)
| Tel.: ++49 (0)7836/2151, Fax.: ++49 (0)7836/955240
| http://www.gpi.kit.edu/BFO.php
----- END OF README.1st -----
this is <README.copying>
============================================================================
information regarding copyright and licensing
---------------------------------------------
$Id: $
============================================================================
All published source code directories (published in form of snap-shot
tar-balls) contain a file named COPYING which contains specific copyright and
licensing information.
Information applicable to the entire TFSoftware repository is provided in
/texts/README.licence_and_copyright (based at the root of the repository).
----- END OF README.copying -----
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