diff options
| author | louie <lshprung@yahoo.com> | 2020-12-20 15:35:43 -0800 |
|---|---|---|
| committer | louie <lshprung@yahoo.com> | 2020-12-20 15:35:43 -0800 |
| commit | fa8e3992ef7060168770ccccabdfe3b2982ea700 (patch) | |
| tree | a93213dd68e6f33b340d88e62e37514e7a9e5a4b /docs/README.md | |
| parent | 468126196aba8aa60289393d5c0e5c8b3b2efcfb (diff) | |
Updated docs to reflect changes from last commit
Diffstat (limited to 'docs/README.md')
| -rw-r--r-- | docs/README.md | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/docs/README.md b/docs/README.md index db5da29..e5b8605 100644 --- a/docs/README.md +++ b/docs/README.md @@ -4,7 +4,7 @@ ## Compiling and Running -tml can be compiled on any system with make, gcc, and the ncurses library (libncurses-dev) installed. It has been tested to work on Ubuntu, and can also be compiled and run on Windows 10, but is designed with Linux in mind. To compile and run tml: +tml can be compiled on any system with make, gcc, and the ncurses library (libncurses-dev) installed. It can be compiled and installed on any Linux distribution, and can also be compiled and run on Windows 10. To compile and run tml: 1. Clone the repository 2. Run `make` in the directory the repository was cloned into. This will create a file called `tml` @@ -14,7 +14,7 @@ Note that tml will not run until you have created a configuration file. ### Installation -tml can be installed by running: +tml can be installed on Linux by running: ``` sudo make install @@ -36,9 +36,14 @@ sudo make uninstall By default, tml searches in the following order for a configuration file: +### Linux + 1. `$HOME/.config/tml/config` 2. `$HOME/.tml/config` -3. `config` (in the current directory) + +### Windows + +1. `%APPDATA%\tml\config` A different configuration file location can also be specified with the `-c` flag: |