patrick
/
tt
mirror of https://github.com/PatrickLipka/tt.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Simple Command Line Time Tracker
47 Commits 2 Branches 6 Tags 129 KiB
C++ 96.7%
Makefile 3%
C 0.3%
Go to file
Patrick Lipka 1d4ffa73e5 Settings section added 2021-12-17 13:29:00 +01:00
src cleanup done, more verbose comments added 2021-12-17 12:05:13 +01:00
.gitignore Initial commit 2021-12-06 10:47:19 +01:00
LICENSE Initial commit 2021-12-06 10:47:19 +01:00
Makefile -std=c++11 added to compile flags to solve clang warnings 2021-12-17 10:25:32 +01:00
README.md Settings section added 2021-12-17 13:29:00 +01:00

README.md

tt

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.

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 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 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

Makefile variables

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 The user name and tracking directory can also be set after installation by modifying $PREFIX/etc/tt.conf

Build command

The default install process is:

USER_NAME="<Your full name>" make
sudo make install

Note that there is no /home directory on macOS. You may want to set TRACKING_DIR=/Users/$USER/track.

Settings

The file $PREFIX/etc/tt.conf has the format key=value and contains the following settings:

  • user_name - user name to be mentioned in monthly reports
  • tracking_directory - directory where tracking files are saved and loaded from

Usage