From 199d0493a0f04166560737ef1fe6c11358b891f6 Mon Sep 17 00:00:00 2001 From: Patrick Lipka Date: Fri, 17 Dec 2021 13:09:36 +0100 Subject: [PATCH] added first install variables --- README.md | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 6db1df1..91f1267 100644 --- a/README.md +++ b/README.md @@ -6,17 +6,21 @@ This software is licensed under the BSD-2-clause license. Please see LICENSE for ## Dependencies The program uses GNU Readline (https://tiswww.case.edu/php/chet/readline/rltop.html) for command completion and history. \ The Readline library is free software, distributed under the terms of the [GNU] General Public License as published by the Free Software Foundation, version 3 of the License. \ -Packages are available on most Linux distributions and BSD systems as well as macOS. Depending on your OS you man need to also install a package like libreadline-dev to have access to the headers.\ +Packages are available on most Linux distributions and BSD systems as well as macOS. Depending on your OS you man need to also install a package like libreadline-dev to have access to the headers. -The program assumes POSIX functionalities as provided by unistd.h. The best way to run it on Windows might be to install a Unix compatibility layer or use Windows' Subsystem for Linux.\ +The program assumes POSIX functionalities as provided by unistd.h and a Unix file system layout. The best way to run it on Windows might be to install a Unix compatibility layer or use Windows' Subsystem for Linux.\ To compile the program you need a C++ compiler which supports the C++11 standard. -The program has ben tested on the following systems: +The program has been tested on the following systems: * Debian Linux 5.10.70-1, GCC 10.2.1 20210110 * macOS 11.5.2, Apple clang 12.0.5 ## Installation - +The following variables can be used to configure the build: +* `CXX` - C++ compiler, defaults to `g++` +* `PREFIX` - install prefix, defaults to `/usr/local` +* `USER_NAME` - user name to be mentioned in monthly reports, defaults to `$USER` +* `TRACKING_DIR` - directory where tracking files are saved, defaults to `/home/$USER/track` ## Settings