Readme

README
Install
Usage
Configure

README

This is a simple project to help sort your files on linux written in c++.

Install

Coppy the repo

git clone https://github.com/ZastianPretorius/fsorter.git

cd into the the fsorter folder
```
. cd fsorter
```
Generate a make files
```
cmake .
```
Compile the project
```
make
```
install the project (will require sudo)
```
sudo make install
```

Usage

cd to the desired location for example
```
cd ~/Downloads
```
The first time you run the program nothing will happen but a default settings.conf will be generated found in
```
~/.config/fsorter/settings.conf
```
Running #+BEGIN_SRC fsorter #+END_SRC again will sort the current working directory based on the preferences in settings.conf

Configure

Open #+BEGIN_SRC ~/.config/fsorter/settings.conf #+END_SRC in your favourite text editor for example.
```
vim ~/.config/fsorter/settings.conf
```

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)

 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,

The config file is janky so be careful
An object consists of 3 things first a Type #+BEGIN_SRC Picture= #+END_SRC dont forget the '=' at the end.
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.
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.
If this convention is not followd the program will brake.
You can add your own types at the end of this file. DO NOT leave empty lines.
The Types can be enything as long as it ends with '='.
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.
Extentions can be anything as long as the convention is followd as shown above.