summaryrefslogtreecommitdiffstats
path: root/README.md
blob: 749ad8fd2e24a7fcda921cb4e93b7a23d87ffbe9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
# cras - The Anti-Procrastination Tool

cras is an unapologetic daily task planner and manager for your terminal and WM
status bar. It holds your tasks only for a limited amount of time (24 hours, by
default).

## Build
cras doesn't require any external dependencies.

Build by using:

```
$ make
```

Customize the build process by changing config.mk to suit your needs.

User configuration is performed by modifying config.h. A set of defaults is 
provided in config.def.h.

## Usage
cras reads a task list from a file that is passed as an argument through the 
command line. With no further options added, the default behavior is to output
the pending tasks, but only if the expiration time has not passed yet.

```
$ cras my-dev-todo
Tasks due for: Sat Jun 20 15:57:28 2020

#01 [TODO] Write README.md
#02 [TODO] Set up git repo for cras
#03 [TODO] Succeed in life

3/0/3 to do/done/total
```

To set a task list, pass the -n option and the name of the file that will hold
the list. The tasks will be read from standard input, each line being a new 
task. cras stops reading when it reaches EOF.
 
The -t and -T, followed by the task number, mark the task as done or pending, 
respectively.

Adding new tasks to an already existing file is possible by using the -a 
option. Tasks can be delated by using the -d option, specifying the number of 
the desired task. Editing the description of a task can be done by using -e.

For further usage information, please refer to the cras(1) manual page.

## Install
You may install cras by running the following command as root:

```
# make install
```

This will install the binary under $PREFIX/bin, as defined by your environment,
or /usr/local/bin by default. The Makefile supports the $DESTDIR variable as 
well.

## Cultural trivia
_cras_ means 'tomorrow' in Latin, hence the English word _procrastination_ 
means, literally, 'the act of posponing things for tomorrow.'

## License
cras is published under an MIT/X11/Expat-type License. See LICENSE file for 
copyright and license details.