Next: , Previous: Commands, Up: Top


3 Installation

3.1 How to install

These are installation instructions for documentation. (Version: 0.1.1 from Tuesday May 02 23:09:35 2006)

3.1.1 The simplest way

The simplest way to use this package is by not installing it at all, but just use it from where it is. Yes you don't have to install it. You can just call the programs. If that's your way do the following:

  1. cd into the packages root directory. For example cd ~/myPackages/documentation.
  2. Call ./siliconBrainInstall without any parameters.
  3. The last two lines contain settings, which you should include somewhere to be executed, where you like to use this package. So for instance you can add these two lines to your .bash_profile. All output of siliconBrainInstall is written to stderr except the last two lines, which are written to stdout. So you can also call: 
              ./siliconBrainInstall > fileToRememberTheSettings

3.1.2 Install the package somewhere

If you want the package to be installed somewhere, you have to follow this section.

First we have to clarify some concepts.

The installationPath is the directory, where to the package directory will be installed. An example is /usr/local or ~/myPackages. This directory must exist prior to installation. You can use /usr/local (or a directory below), if you use siliconBrain for your own developed software. You can use /usr (or a directory below), if this package is delivered by someone else.

The installationDirectory is the newly created package root directory. The installationDirectory will be created by siliconBrainInstall. Normally part of its name is the package name and/or the release number. When you specify the installationDirectory you can use some place-holders:

%p
This is replaced by the package name. You an use this placeholder when you write a script, which will be used for more than one siliconBrain package.
%r
The release number of the package. For example “0.1.42”.
%R
The release number, but with underscores instead of dots. For example “0_1_42”.

So specifying %p_%R will result in documentation_0_1_42.

There are three ways to specify installation path and directory:

As in subsection “The simplest way” at the end the script will output two lines which you can add to your configuration. And all output is written to stderr and just the two last lines are written to stdout. Thus you can collect the two lines with redirection.

3.1.3 Compile this package

  1. Make sure that the siliconBrain main package is installed.
  2. Make sure that the packages root directory has the same name as the package (documentation). (If not the directory name will become the new package name.)
  3. cd to the directory containing the package's source code and type make.
  4. Use ./siliconBrainInstall as described in section “Install the package somewhere”. Or you can use make install, which just calls siliconBrainInstall with no arguments. If you do so, siliconBrainInstallPath and siliconBrainInstallDirectory should be set correctly.

3.2 Overview

This is documentation (0.1.1). It is my (joerg kunze) personal web site as a siliconBrain project.

documentation personal web site of myself implemented as a siliconBrain project. This way showing that documents are programs or can be teated as such.

Current version is: 0.1.1 from Tuesday May 02 23:09:35 2006

The primary distribution point is ftp://ftp.siliconbrain.com/pub/ and the primary home page is http://www.siliconbrain.com/documentation.

Mail to: Joerg Kunze

For generic installation instructions on compiling and installing this distribution, please read the file `INSTALL'.

This distribution includes the following files, among others:

AUTORS
Who has worked on this project.
COPYING
Terms and conditions for copying program sources.
COPYING.DOC
Terms and conditions for copying the documents.
ChangeLog
History of changes.
INSTALL
Basic installation guidelines.
INTRODUCTION
Brief introduction to the system.
NEWS
Summary of new features by release.
README
This file.
RELEASE
The release number of this package.
TODO
What is still to be done.
makefile
The file for "make" to recompile the package.
temporary
Directory containing all interim generated and compiled files, which are only needed for the make and build process.
distribution
The results of make, which will be used when using this package.
distribution/documentation/documentation.info
The main documentation as info file.
distribution/documentation/documentation.dvi
The main documentation for printed output.
distribution/documentation/web/index.html
The main documentation in HTML.
temporary/documentation/siliconBrain.info
The main documentation as info file.
temporary/documentation/siliconBrain.dvi
The main documentation for printed output.
temporary/documentation/web/index.html
The main documentation in HTML.

Note: the same file with the ".template" extension do not describe the siliconBrain package, but are templates used by siliconBrain to set up new projects or packages.

3.3 NEWS

This file records noteworthy changes.

3.3.1 0.0.86 (30 April 2006)

• general organisation:
− created as a siliconBrain project.
− deploy.command to autodeploy.
− remove uninteresting parts.
− introduce CVS keywords in HTML pages.

3.4 TODO

3.4.1 These are the things, which are to be done sometimes:

• general:
− put copyright header into all htm files (test)
− put cvs key words in all htm files (write a test)
− make sure all internal links are correct
− rewrite index.htm
• automate and programming:
− write testMain.main.c
− test copyright notice
− test key word usage
− test internal link integrety
− test external link integrety
− test deployed htm pages (wget)

3.5 AUTHORS

The following persons have contributed to this package: