summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorlshprung <lshprung@yahoo.com>2020-10-12 22:20:55 -0700
committerlshprung <lshprung@yahoo.com>2020-10-12 22:20:55 -0700
commit4313a39544cde16e5750f5affc1b7702770c1699 (patch)
tree71e0ea2862f0daad8c40fbce0869c6f5699a9cff /docs
parentd529fcc336110d243beeef3d393c1122a8238a39 (diff)
Improved error messages and readme
Diffstat (limited to 'docs')
-rw-r--r--docs/README.md7
-rw-r--r--docs/screenshot1.pngbin0 -> 28376 bytes
-rw-r--r--docs/screenshot2.pngbin0 -> 33241 bytes
-rw-r--r--docs/tml-config.5.gzbin2153 -> 2150 bytes
-rw-r--r--docs/tml-config.md4
5 files changed, 8 insertions, 3 deletions
diff --git a/docs/README.md b/docs/README.md
index 9a7db57..db5da29 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -4,7 +4,7 @@
## 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 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 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:
1. Clone the repository
2. Run `make` in the directory the repository was cloned into. This will create a file called `tml`
@@ -27,6 +27,11 @@ To uninstall these files:
sudo make uninstall
```
+## Screenshots
+
+![screenshot 1](screenshot1.png)
+![screenshot 2](screenshot2.png)
+
## Configuration File
By default, tml searches in the following order for a configuration file:
diff --git a/docs/screenshot1.png b/docs/screenshot1.png
new file mode 100644
index 0000000..7c11b94
--- /dev/null
+++ b/docs/screenshot1.png
Binary files differ
diff --git a/docs/screenshot2.png b/docs/screenshot2.png
new file mode 100644
index 0000000..903304b
--- /dev/null
+++ b/docs/screenshot2.png
Binary files differ
diff --git a/docs/tml-config.5.gz b/docs/tml-config.5.gz
index 8f06624..429dd3d 100644
--- a/docs/tml-config.5.gz
+++ b/docs/tml-config.5.gz
Binary files differ
diff --git a/docs/tml-config.md b/docs/tml-config.md
index 63f3cfb..b02ee21 100644
--- a/docs/tml-config.md
+++ b/docs/tml-config.md
@@ -126,7 +126,7 @@ autoAlias on
# Adding a Group of Various Applications
-addGroup Applcations
+addGroup Applications
addName GIMP /usr/bin/gimp Applications
addName Chromium /usr/bin/chromium-browser Applications
addName Thunderbird /usr/bin/thunderbird Applications
@@ -141,7 +141,7 @@ add /home/john/Videos/*mp4 Videos
addGroup Pictures
setLauncher Pictures /usr/bin/sxiv
-setFlags "-s f"
+setFlags Pictures "-s f"
add /home/john/Pictures/*jpg Pictures
add /home/john/Pictures/*png Pictures
addR "/mnt/External_Drive/Johns Photos/*" Pictures