diff --git a/README.md b/README.md index 7c7835c..a0837f8 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,12 @@ Simple plain-text time tracking. The Python script `tx` provides short-hands for accessing and reading a `time.txt` file, as described below. +## Installation + +For testing, you can just run `tx` in this directory using `./tx`. + +If you want to be able to use it anywhere, run `install.sh`. The `tx` command should then be available in any folder. + ## Usage Create a new `time.txt` file at the current location: `tx create` diff --git a/install.sh b/install.sh new file mode 100755 index 0000000..0bb935b --- /dev/null +++ b/install.sh @@ -0,0 +1 @@ +sudo ln -s $(pwd)/tx /usr/local/bin/tx