summaryrefslogtreecommitdiff
path: root/docs/README.md
diff options
context:
space:
mode:
authorlouie <lshprung@yahoo.com>2020-08-18 18:24:59 -0700
committerlouie <lshprung@yahoo.com>2020-08-18 18:24:59 -0700
commitb35606d04316b3ba2c9c7a5fcdaf12a3ac3e6ccc (patch)
tree133838484047a5d123dcf3ee7ea3456e4f8d5de9 /docs/README.md
parent73ba31618b28d72e241ff066080ed1a407a82aa3 (diff)
Added hideFile option to read_cfg
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md10
1 files changed, 8 insertions, 2 deletions
diff --git a/docs/README.md b/docs/README.md
index 7e01ebd..a3b3842 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -4,7 +4,7 @@
## Compiling and Running
-tml can be installed on any system with gcc and the ncurses library installed. It has been tested to work on Ubuntu and Windows 10. To compile and run tml:
+tml can be compiled on any system with gcc and the ncurses library installed. It has been tested to work on Ubuntu and 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`
@@ -20,4 +20,10 @@ By default, tml searches in the following order for a config file:
2. `$HOME/.tml/config`
3. `config` (in the current directory)
-A different config file location can also be specified with the `-c` flag. For Documentation of the config file, see [tml-config](tml-config.md)
+A different config file location can also be specified with the `-c` flag:
+
+```
+tml -c /path/to/config
+```
+
+For Documentation of the config file, see [tml-config](tml-config.md)