From: Bastian Dehn <hhaalo@arcor.de>
Date: Wed, 17 Jul 2024 13:18:25 +0000 (+0200)
Subject: add readme
X-Git-Tag: 1.0.1^2~1
X-Git-Url: https://gitweb.hhaalo.de/?a=commitdiff_plain;h=4b71cbad0060c13fd776de170716821c583edfa0;p=mv_none_space.git

add readme
---

diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..b1afa62
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,40 @@
+# mv_none_space
+
+Is a tool it renames files without spaces and translate umlauts into normal
+characters.
+
+## Build
+
+You can build with following commands:
+
+```bash
+mkdir build && cd build
+cmake -DCMAKE_BUILD_TYPE=Release ..
+make
+```
+
+or build a dep package with command:
+
+```bash
+make package
+```
+
+## Usage
+
+Only rename spaces and umlauts:
+
+```bash
+mv_none_space /path/to/rename
+```
+
+Rename spaces, umlauts and make lower case:
+
+```bash
+mv_none_space /path/to/rename lower
+```
+
+Rename spaces, umlauts and no dots at the end
+
+```bash
+mv_none_space /path/to/rename point
+```
\ No newline at end of file