diff --git a/README.md b/README.md index c46a212..8007244 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ Software Installation Tool (SIT) -------------------------------- SIT is a simple software installation tool inspired by gentoo's emerge script. -It eases the installation process and helps to prevent errors during the +It eases the installation process and helps to prevent errors during the installation as well as helps with the documentation as it generates a lot of log files and installes them together with the softwre package. @@ -17,16 +17,16 @@ convenience it should look like following The global configuration file of SIT is $SIT_PATH/etc/sit.conf It includes a variety of default values: * PREFIX_BASE -* SRC_POOL +* SRC_POOL * SCLASS_DIR * DEFAULT_PLATFORM * DEFAULT_COMPILER -A user specific configuration file $HOME/.sit" can be used to overwrite the +A user specific configuration file $HOME/.sit" can be used to overwrite the settings in the global configuration file. -The installation process is currently controled with the following environment +The installation process is currently controled with the following environment variables: * COMPILER * COMPILER_VERSION @@ -38,13 +38,13 @@ variables: Sit detects currently the build platform using the SITE_PLATFORM_NAME variable. If sit cannot determine the PLATFORM it uses the default platform specified in sit.conf. -For each platform configuration files are stored unter +For each platform configuration files are stored unter $SIT_PATH/etc/platform-configs/$PLATFORM/* At the moment only compiler configurations are supported. -To install a package simply call sit with the necessary information provided by +To install a package simply call sit with the necessary information provided by these variables: > [VARIABLE_DECLARATIONS] sit PACKAGE @@ -82,7 +82,7 @@ BUILDDIR directory in which the package will be build ($SRCDIR/build) LOGDIR directory storing the temporary logfiles ($WORKDIR) -For fine tuning of the installation process the user can overwrite the following +For fine tuning of the installation process the user can overwrite the following functions. If not other mentioned they are executed in $BUILDDIR src_unpack extract $SRC_POOL/${A} into $WORKDIR @@ -94,7 +94,7 @@ src_install make install src_posttest tests to be done after installation -The following helper functions can be used +The following helper functions can be used unpack recognize and extract a compressed tar file