Readme

• README
• Install
• Usage
• Configure

README

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

Install

1. Copy the repo

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

2. cd into the fsorter folder

   cd fsorter

3. Generate a make files

   cmake .

4. Compile the project

   make

5. install the project (will require sudo)

   sudo make install

Usage

1. cd to the desired location for example

   cd ~/Downloads

2. Run fsorter.

   fsorter

3. The first time you run the program nothing will happen but a default settings.toml will be generated found in

   ~/.config/fsorter/settings.toml

4. Running fsorter again will sort the current working directory based on the preferences in settings.toml

Configure

1. Open ~/.config/fsorter/settings.conf in your favourite text editor for example.

   vim ~/.config/fsorter/settings.conf

2. Here is the basic settings.toml. 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 automatically)

   [Picture]
   path = "/home/mrfluffy/Pictures/"
   extensions = [".jpg",".jpeg",".png"]
   [Music]
   path = "/home/mrfluffy/Music/"
   extensions = [".mp3",".wav"]
   [Video]
   path = "/home/mrfluffy/Videos/"
   extensions = [".mp4"]
   [Arcive]
   path = "/home/mrfluffy/Documents/Compressed/"
   extensions = [".zip",".rar",".7z"]

3. [Picture] is an example of a category. This can be what ever you want to call it.
4. path = "home/mrfluffy/Pictures" is the path you want to save all the files that fall in to this category.
5. extensions = [".jpg",".jpeg",".png"] is all the extensions of files that fall under this category.