From 8e07ca788857e5a495c5cab0cb63b1c644a46fe1 Mon Sep 17 00:00:00 2001
From: jozan <jozan@noemail.net>
Date: Fri, 27 Nov 2020 23:37:22 +0000
Subject: Very good

FossilOrigin-Name: 74b84c62aecd4cd986e624d330525b1dc910f0c85717300295f6d18f53ef6a3b
---
 README.md | 82 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 82 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..a760ae4
--- /dev/null
+++ b/README.md
@@ -0,0 +1,82 @@
+
+# Table of Contents
+
+1.  [Dependencies](#org0b55cd2)
+2.  [Installation](#orgc36ed01)
+3.  [Usage](#org06b1425)
+4.  [End note](#orgd171c54)
+
+**unixize** is a small tool to bulk rename files into a cool UNIX-friendly
+standard. Basically, everything becomes lowercase and there is no need to
+escape characters anymore when entering your filenames in a terminal. It
+also removes unicode characters.
+
+**unixize** is configurable through options. Refer to
+
+    man unixize
+
+to get a list of options.
+
+
+<a id="org0b55cd2"></a>
+
+# Dependencies
+
+-   A C compiler
+-   GNU Make
+
+
+<a id="orgc36ed01"></a>
+
+# Installation
+
+You can get **unixize** either through `git` or `fossil`.
+
+For `fossil` use:
+
+    mkdir unixize
+    cd unixize
+    fossil clone https://chiselapp.com/user/JozanLeClerc/repository/unixize unixize.fossil
+    fossil open --force unixize.fossil
+
+or for `git`:
+
+    git clone git://jozanleclerc.xyz/jozan/unixize.git
+    cd unixize
+
+Then build the program:
+
+    make
+    sudo make install clean
+
+Note that on BSD systems you want to use `gmake` instead of `make`:
+
+    gmake
+    sudo gmake install clean
+
+
+<a id="org06b1425"></a>
+
+# Usage
+
+**USE WITH CAUTION**.
+
+Without the `-p` option, **unixize** will commit to do exactly
+what it's supposed to do, rename all the badly formatted in the chosen
+directory. To deunixize your files, you'll have to rename everything
+manually.
+
+    cd messy_directory
+    unixize -v -r .
+
+
+<a id="orgd171c54"></a>
+
+# End note
+
+Please note that unixize was tested only on FreeBSD at the moment.
+Linux and macOS tests are coming soon.  You can report bug on
+[GitHub](https://github.com/JozanLeClerc/unixize.git).
+
+Thanks for checking **unixize**.
+
-- 
cgit v1.2.3