Skip to content
This repository has been archived by the owner on Dec 5, 2023. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
CoolCoderCarl committed May 17, 2022
1 parent cdcb6ce commit 5255527
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,10 @@ Clean your castle
## Prehistory
This CLI program provides functions for maintaining order on a server or home computer.

The author was tired of watching how a dump is constantly formed in his Downloads directory (and not only) and he decided to end it.
> How tired I am of looking at this trash in Downloads.
> (c) Author
For this purpose this program was developed in the Python language.
To fix this problem this program was developed in the Python language.

In fact, this program is a working prototype for a similar Golang program, but you can already use it now.

Expand All @@ -16,26 +17,27 @@ Enjoy.

## How to use
The program provides three functions:
**Cleaning**
**Grouping**
**Archiving**
1. **Cleaning**
2. **Grouping**
3. **Archiving**

In case the first and third functions are already familiar, grouping may seem like an interesting function.

### In order
**It is important to close slashes.**

### Examples
**Cleaning**
`butler.exe --clean /path/to/dir/`
Clean target dir. It is important to close slashes.
Clean target dir but not delete it.

**Grouping**
`butler.exe --dir /path/to/dir/`
Group up files by extensions to new directory named *ALL*.*EXT*.
For example, you have a lot of *.exe* files, after this command you will have one directory called *ALL.EXE* with all your *.exe* files in it.
It is important to close slashes.
For example, you have a lot of *.exe* files, after this command you will have one directory called *ALL.EXE* with all your *.exe* files in it.

**Archiving**
`butler.exe --archive /path/to/dir/`
Create zip archive in current directory for target directory. It is important to close slashes.
Create zip archive in current directory for target directory.


## Golang version
Expand Down

0 comments on commit 5255527

Please sign in to comment.