Added dependencies section

This commit is contained in:
Patrick Lipka 2021-12-17 12:27:04 +01:00
parent 12ade72c9a
commit 6744c4bcff
1 changed files with 13 additions and 1 deletions

View File

@ -1,11 +1,23 @@
# tt # tt
Simple Command Line Time Tracker written by Patrick Lipka (patrick.lipka@emea.nec.com) Simple command line time tracker for POSIX systems.
Written by Patrick Lipka (patrick.lipka@emea.nec.com)
This software is licensed under the BSD-2-clause license. Please see LICENSE for details. This software is licensed under the BSD-2-clause license. Please see LICENSE for details.
## Dependencies ## 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.
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.
To compile the program you need a C++ compiler which supports the C++11 standard.
The program has ben 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 ## Installation
## Settings ## Settings
## Usage ## Usage