diff options
Diffstat (limited to 'docs/README.md')
| -rw-r--r-- | docs/README.md | 34 |
1 files changed, 17 insertions, 17 deletions
diff --git a/docs/README.md b/docs/README.md index 97b414a..08a5784 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,28 +1,28 @@ ## 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 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. +**Terminal Media Launcher** is a command line utility to help streamline launching applications and other media. The goal of this program 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 For Windows instructions, see [here](windows_compile_instructions.md) -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: +terminal-media-launcher 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 terminal-media-launcher: 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 +2. Run `make` in the directory the repository was cloned into. This will create a file called `terminal-media-launcher` +3. `./terminal-media-launcher` to run the program -Note that tml will not run until you have created a configuration file. +Note that terminal-media-launcher will not run until you have created a configuration file. ### Installation -tml can be installed on Linux by running: +terminal-media-launcher can be installed on Linux by running: ``` sudo make install ``` -This will install `tml` to `/usr/local/bin/tml` as well as man pages `tml` and `tml-config`. +This will install `terminal-media-launcher` to `/usr/local/bin/terminal-media-launcher` as well as man pages `terminal-media-launcher` and `terminal-media-launcher-config`. To uninstall these files: ``` @@ -31,13 +31,13 @@ sudo make uninstall ### Create Desktop Entry -If tml is installed (see above), a Desktop Entry can be created on Linux by running: +If terminal-media-launcher is installed (see above), a Desktop Entry can be created on Linux by running: ``` sudo make desktop-entry ``` -This will create a desktop entry at `/usr/local/share/applications/tml.desktop`. +This will create a desktop entry at `/usr/local/share/applications/terminal-media-launcher.desktop`. ## Screenshots @@ -46,23 +46,23 @@ This will create a desktop entry at `/usr/local/share/applications/tml.desktop`. ## Configuration File -By default, tml searches in the following order for a configuration file: +By default, terminal-media-launcher searches in the following order for a configuration file: ### Linux -1. `$HOME/.config/tml/config` -2. `$HOME/.tml/config` +1. `$HOME/.config/terminal-media-launcher/config` +2. `$HOME/.terminal-media-launcher/config` ### Windows -1. `%APPDATA%\tml\config` +1. `%APPDATA%\terminal-media-launcher\config` A different configuration file location can also be specified with the `-c` flag: ``` -tml -c /path/to/config +terminal-media-launcher -c /path/to/config ``` -For Documentation of the configuration file, see [tml-config](tml-config.md). -For a help message and list of flags, `tml --help`. -If you installed tml, you can also consult **tml**(1) and **tml-config**(5). +For Documentation of the configuration file, see [terminal-media-launcher-config](terminal-media-launcher-config.md). +For a help message and list of flags, `terminal-media-launcher --help`. +If you installed terminal-media-launcher, you can also consult **terminal-media-launcher**(1) and **terminal-media-launcher-config**(5). |