aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorJack Jamison <jackqjamison@gmail.com>2025-11-04 21:50:28 -0500
committerJack Jamison <jackqjamison@gmail.com>2025-11-06 19:45:03 -0500
commit53aae53b6e6ab394bee5992a1978c87ee7dba9f5 (patch)
tree0f182d4ad11cf1fade4f826e851b3594c132dc73 /README.md
parent2fe0e7afd0da6bf128cd5d8d99180cc3a75eca0a (diff)
config file
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 17 insertions, 1 deletions
diff --git a/README.md b/README.md
index 16a8fb4..cb4b4c0 100644
--- a/README.md
+++ b/README.md
@@ -15,6 +15,21 @@ Usage: just like dmenu
## FAQ
Q: What is an ENU?
+## Configuration
+Create your config file at `XDG_CONFIG_HOME/swenu/conf.ini` or `HOME/.config/swenu/conf.ini`.
+Example config file:
+```ini
+fancy_scroll = false
+min_width = 500
+font_size = 16
+
+[colors]
+text_color = (0.85, 0.85, 0.85, 1.0)
+highlight_color = (0.1, 0.3, 0.7, 1.0)
+background_color = (0.1, 0.1, 0.1, 1.0)
+cursor_color = (0.9, 0.9, 0.9, 0.5)
+```
+
## Todo -
- [x] "selection"
- [x] figure out whats going on with stderr and exit code
@@ -28,9 +43,10 @@ Q: What is an ENU?
- [x] emacs keybindings
- [x] "prompt"
- [x] fuzzy filter
-- [ ] config file
+- [x] config file
- [ ] scrolling in input
- [ ] unicode + text shaping
Stretch:
+- [ ] clean up the code (src folder, rename some files)
- [ ] input fluff (icons, descriptions, output names)