From 6558b67a14376a59c5bed90419072f3b6b2fa7cb Mon Sep 17 00:00:00 2001
From: Zastian Pretorius <zastian00@gmail.com>
Date: Sat, 23 Oct 2021 22:18:40 +0200
Subject: [PATCH] made changes to the README.org

---
 README.org | 44 ++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 44 insertions(+)

diff --git a/README.org b/README.org
index 95b20db..58f829d 100644
--- a/README.org
+++ b/README.org
@@ -24,3 +24,47 @@ This is a simple project to help sort your files on linux written in c++.
    #+BEGIN_SRC
    sudo make install
    #+END_SRC
+* Usage
+1. cd to the desired location for example
+   #+BEGIN_SRC
+   cd ~/Downloads
+   #+END_SRC
+2. The first time you run the program nothing will happen but a default settings.conf will be generated found in
+   #+BEGIN_SRC
+   ~/.config/fsorter/settings.conf
+   #+END_SRC
+3. Running #+BEGIN_SRC fsorter #+END_SRC again will sort the current working directory based on the preferences in settings.conf
+
+* Configure
+1. Open #+BEGIN_SRC ~/.config/fsorter/settings.conf #+END_SRC in your favourite text editor for example.
+   #+BEGIN_SRC
+   vim ~/.config/fsorter/settings.conf
+   #+END_SRC
+2. Here is the basic settings.conf. The name after /home/ will be different then this one it must be your systems username (Running fsorter the first time will generate this for you automaticaly)
+   #+BEGIN_SRC
+    Picture=
+    /home/mrfluffy/Pictures/
+    .jpg,.jpeg,.png,
+    Music=
+    /home/mrfluffy/Music/
+    .mp3,.wav,
+    Video=
+    /home/mrfluffy/Videos/
+    .mp4,
+    Arcive=
+    /home/mrfluffy/Documents/Compressed/
+    .zip,.rar,.7z,
+    ISO=
+    /home/mrfluffy/Documents/ios/
+    .iso,
+    #+END_SRC
+3. The config file is janky so be careful
+4. An object consists of 3 things first a Type #+BEGIN_SRC Picture= #+END_SRC dont forget the '=' at the end.
+5. second is the path you want to save your files of this type for the Type Picture= in this case it is #+BEGIN_SRC /home/mrfluffy/Pictures/ #+END_SRC dont forget the '/' at the end of path.
+6. The third if the extentions That belong to this type in the case of Type Picture= we have #+BEGIN_SRC .jpg,.jpeg,.png, #+END_SRC take note that the extentions have a '.' before them and they are seperated by a ','
+   Also note that there is a ',' at the end of the line.
+7. If this convention is not followd the program will brake.
+8. You can add your own types at the end of this file. DO NOT leave empty lines.
+9. The Types can be enything as long as it ends with '='.
+10. The path does not need to exist when #+BEGIN_SRC fsorter #+END_SRC is ren it will ask you if you want to create the Directory.
+11. Extentions can be anything as long as the convention is followd as shown above.