todo.txt-cli/README.md at 1378c97d8023acdb4f0484da17f77718e5708b5c

Files

LeLobster c6d290b5fb Fix the Makefile to work with the install instructions in the README (#259 )

* Fix the Makefile to work with the install instructions in the README

* Put back DEST_DIR

* Add simple ifdef checks to see if the user has set custom dirs via the commandline

* Update README to match Makefile

2020-03-29 14:29:40 -05:00

2.8 KiB

Raw Blame History

A simple and extensible shell script for managing your todo.txt file.

Read our contributing guide if you're looking to contribute (issues/PRs/etc).

Installation

Download

Download the latest stable release for use on your desktop or server.

OS X / macOS

brew install todo-txt

Linux

From command line

make
make install
make test

NOTE: Makefile defaults to several default paths for installed files. Adjust to your system:

INSTALL_DIR: PATH for executables (default /usr/local/bin)
CONFIG_DIR: PATH for todo.txt config
BASH_COMPLETION: PATH for autocompletion scripts (default to /etc/bash_completion.d)

make install CONFIG_DIR=/etc INSTALL_DIR=/usr/bin BASH_COMPLETION=/usr/share/bash-completion/completions

Arch Linux (AUR)

https://aur.archlinux.org/packages/todotxt-git/

Usage

todo.sh [-fhpantvV] [-d todo_config] action [task_number] [task_description]

For example, to add a todo item, you can do:

todo.sh add "THING I NEED TO DO +project @context"

Read about all the possible commands in the USAGE file.

Release History

See CHANGELOG.md

Support

Code of Conduct

Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Contributing

We welcome all contributations. First read our Contributor Code of Conduct and then get started contributing.

2.8 KiB Raw Blame History