Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
constarg authored Dec 18, 2023
1 parent 0f1b832 commit 93c06dd
Showing 1 changed file with 19 additions and 19 deletions.
38 changes: 19 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@

# Introduction

Welcome to file-sorter-core, your new ally in conquering the chaos of file organization. This lightweight and flexible service is designed to rescue your files from the abyss of disorder, operating seamlessly based on a straightforward config file. Imagine giving specific orders to your file-sorter like – "Hey, check /home/username/Desktop/, and if you find any *.py files, move them to /home/username/py!" It's that simple.
Welcome to sushi-shuffle, your new ally in conquering the chaos of file organization. This lightweight and flexible service is designed to rescue your files from the abyss of disorder, operating seamlessly based on a straightforward config file. Imagine giving specific orders to your file-sorter like – "Hey, check /home/username/Desktop/, and if you find any *.py files, move them to /home/username/py!" It's that simple.

# Installation Requirements

Before diving into the file-sorting fun, make sure to install the necessary packages:
Before diving into the sushi-shuffle fun, make sure to install the necessary packages:

```bash
sudo apt-get install build-essential cmake git gcc
Expand All @@ -17,8 +17,8 @@ sudo apt-get install build-essential cmake git gcc

Get started by cloning the repository and navigating to the File-Sorter-Core folder:
```
git clone https://github.com/constarg/file-sorter-core.git
cd file-sorter-core/
git clone https://github.com/constarg/sushi-shuffle.git
cd sushi-shuffle/
```
Now, let's build the program:

Expand All @@ -37,29 +37,29 @@ Make sure your cmake version is 3.19 or above. If not, grab the latest version f
After this the program will be installed and ready to run.

# Config
Customize your file-sorter experience using the config file located at ~/.local/share/file_sorter/config/config.conf. Set check intervals, debug modes, default paths, and more. The config file has three segments: [check], [targets], and [exclude], allowing you to define locations, file extensions, and rules effortlessly.
Customize your sushi-shuffle experience using the config file located at ~/.local/share/sushi-shuffle/config/config.conf. Set check intervals, debug modes, default paths, and more. The config file has three segments: [check], [targets], and [exclude], allowing you to define locations, file extensions, and rules effortlessly.

# Commands
Command | Description | Comments
--------------------------------------|-------------------------------------------------|---------
file-sorter --start-sorter | Start the sorter service | -
file-sorter --help | Displays all available commands. | -
file-sorter --set-check-interval [value] | Changes the check interval. | -
file-sorter --set-default-dir-path [path] | Changes the default location. | -
file-sorter --set-enable-default-dir [value] | Enable/disable transfers to default dir. | `0:1 Enable the to transfer files in default dir.`
file-sorter --set-debug-log [value] | Switches between debug and normal mode. | `1 (debug mode) and 0 (normal mode)`
file-sorter --set-mv-without-ext [value] | Enable/disable moving files without extension. | `0:1 Enable the program to move files without extension.`
file-sorter --add-check [path] | Adds `[path]` to the list of locations. | -
file-sorter --add-target [ext] [path] | Adds info for file extension `[ext]` to `[path]`. | -
file-sorter --remove-check [row number] | Deletes item at line `[row_number]`. | -
file-sorter --list-checks | Displays all locations the program looks at. | -
file-sorter --list-targets | Displays all elements describing file actions. | -
file-sorter --list-options | Displays program options. | -
sushi-shuffle --start-sorter | Start the sushi shuffle service | -
sushi-shuffle --help | Displays all available commands. | -
sushi-shuffle --set-check-interval [value] | Changes the check interval. | -
sushi-shuffle --set-default-dir-path [path] | Changes the default location. | -
sushi-shuffle --set-enable-default-dir [value] | Enable/disable transfers to default dir. | `0:1 Enable the to transfer files in default dir.`
sushi-shuffle --set-debug-log [value] | Switches between debug and normal mode. | `1 (debug mode) and 0 (normal mode)`
sushi-shuffle --set-mv-without-ext [value] | Enable/disable moving files without extension. | `0:1 Enable the program to move files without extension.`
sushi-shuffle --add-check [path] | Adds `[path]` to the list of locations. | -
sushi-shuffle --add-target [ext] [path] | Adds info for file extension `[ext]` to `[path]`. | -
sushi-shuffle --remove-check [row number] | Deletes item at line `[row_number]`. | -
sushi-shuffle --list-checks | Displays all locations the program looks at. | -
sushi-shuffle --list-targets | Displays all elements describing file actions. | -
sushi-shuffle --list-options | Displays program options. | -

# Service
Run the program as a service using systemd:
```
systemctl --user start file-sorter
systemctl --user start sushi-shuffle
```

# Compatible operating systems
Expand Down

0 comments on commit 93c06dd

Please sign in to comment.