summaryrefslogtreecommitdiff
path: root/docs/README.md
diff options
context:
space:
mode:
authorLouie Shprung <lshprung@tutanota.com>2024-08-30 16:14:26 -0400
committerLouie Shprung <lshprung@tutanota.com>2024-08-30 16:14:26 -0400
commit615c64bcd69eea3660f0a35396255c2eb45fa283 (patch)
tree8e4d8da22240f1ab8da4ff097f74177fcbf24f50 /docs/README.md
parent9cd631a391568c3e75d6f9ee65707dea0bea6d9a (diff)
parenta3d9eb21789bf3587f176e6d155d610b8bc69dab (diff)
Merge branch 'testing'
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md14
1 files changed, 6 insertions, 8 deletions
diff --git a/docs/README.md b/docs/README.md
index cb17fd0..ed1f06a 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -6,20 +6,18 @@
## Compiling and Running
-For Windows instructions, see [here](windows_compile_instructions.md)
-
-terminal-media-launcher can be compiled on any system with make, gcc, and the ncurses development library installed. It can be compiled and installed on any Linux distribution, and can also be compiled and run on Microsoft Windows. To compile and run terminal-media-launcher:
+terminal-media-launcher can be compiled on any system with make, gcc, and the ncurses development library installed. It can be compiled and installed on any Linux distribution, and can also be compiled and run on Microsoft Windows using MinGW (e.g., via [MSYS2](https://www.msys2.org/)). To compile and run terminal-media-launcher:
1. Install dependencies.
On Debian and Debian-based systems:
```
-# apt install gcc libncurses-dev make
+# apt install gcc liblua5.1-0-dev lua5.1 make ncurses-dev pkg-config
```
On RHEL and RHEL-based systems:
```
-# dnf install gcc ncurses-devel
+# dnf install gcc lua lua-devel make ncurses-devel
```
2. Download the latest `.tar.gz` release
@@ -76,12 +74,12 @@ By default, terminal-media-launcher searches in the following order for a config
### Linux
-1. `$HOME/.config/terminal-media-launcher/config`
-2. `$HOME/.terminal-media-launcher/config`
+1. `$HOME/.config/terminal-media-launcher/config.lua`
+2. `$HOME/.terminal-media-launcher/config.lua`
### Windows
-1. `%APPDATA%\terminal-media-launcher\config`
+1. `%APPDATA%\terminal-media-launcher\config.lua`
A different configuration file location can also be specified with the `-c` flag: