summaryrefslogtreecommitdiff
path: root/docs/README.md
diff options
context:
space:
mode:
authorlouie <lshprung@yahoo.com>2020-09-14 10:08:44 -0700
committerlouie <lshprung@yahoo.com>2020-09-14 10:08:44 -0700
commit5b279542ba234d8ca129f72e22332b2f98408de6 (patch)
tree9b50d418f5247ad90e5d35631e14497537f2c114 /docs/README.md
parent405927cf27cdac16869a659f91d3f98d117b51c6 (diff)
Created man page templates, minor documentation adjustments
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md14
1 files changed, 7 insertions, 7 deletions
diff --git a/docs/README.md b/docs/README.md
index a3b3842..86ce1fa 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,29 +1,29 @@
## Introduction
-**Terminal Media Launcher** is a command line utility to help streamline launching applications and other media. The goal of tml is to provide a fast, minimal, command line frontend with a Unix-like approach to setup and configuration. The program looks for a config file listing different groups of media and creates an ncurses menu from which to select from.
+**Terminal Media Launcher** is a command line utility to help streamline launching applications and other media. The goal of tml is to provide a fast, minimal, command line frontend with a Unix-like approach to setup and configuration. The program looks for a configuration file listing different groups of media and creates an ncurses menu from which to select from. If a configuration file is found, the program will draw two columns: one for groups, and one for entries. At the bottom of the window, a preview of the command execution is displayed.
## Compiling and Running
-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:
+tml can be compiled on any system with gcc and the ncurses library installed. It has been tested to work on Ubuntu, 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`
3. `./tml` to run the program
-Note that tml will not run until you have created a config file.
+Note that tml will not run until you have created a configuration file.
-## Config File
+## Configuration File
-By default, tml searches in the following order for a config file:
+By default, tml searches in the following order for a configuration file:
1. `$HOME/.config/tml/config`
2. `$HOME/.tml/config`
3. `config` (in the current directory)
-A different config file location can also be specified with the `-c` flag:
+A different configuration 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)
+For Documentation of the configuration file, see [tml-config](tml-config.md)