aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordavid <[email protected]>2026-06-09 07:53:48 -0300
committerdavid <[email protected]>2026-06-09 07:53:48 -0300
commita52762d70dff4ee0cbad55b7856efe30fc237935 (patch)
tree1372a9fa91b350a1922b20c10adf763df91487b6
parentf8007e4725630d5e4fecd2313797e912204c16ef (diff)
downloadimagesortc-a52762d70dff4ee0cbad55b7856efe30fc237935.tar.gz
imagesortc-a52762d70dff4ee0cbad55b7856efe30fc237935.zip
hello
-rw-r--r--README.md38
1 files changed, 38 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..9ed5766
--- /dev/null
+++ b/README.md
@@ -0,0 +1,38 @@
+a simple image sort tool. shows images one by one and lets you sort them into folders
+
+## dependencies
+
+- SDL2
+- SDL2_image
+- SDL2_ttf
+
+## building
+
+```console
+make
+```
+i reccomend not installing it because it uses ./font/FreeSans.ttf as the font
+so you if you wanna install it you should change the path to one like .local/share/fonts/whatever
+```console
+sudo make install
+```
+## usage
+
+```
+./imagesortc [directory]
+```
+
+if no directory is given, uses the current one. sorted images go into sibling folders relative to the target directory (`../saved`, `../other`, `../delete`).
+
+## controls
+| key | action |
+|-----|--------|
+| Q / A | next / previous image |
+| W | save with custom name (opens text input) |
+| S | move to `../other` |
+| D | move to `../delete` |
+| Enter | confirm name (in typing mode) |
+| Escape | quit |
+
+
+