Fix grammar-related errors and Ponglish expressions.
This commit is contained in:
Kamil Aroński
parent
67a775beff
commit
110f079cbd
65
README.md
65
README.md
|
|
@ -1,52 +1,55 @@
|
|||
# Czkawka
|
||||
Czkawka is simple, fast and easy to use alternative to Fslint, written in Rust.
|
||||
Czkawka is a simple, fast and easy to use alternative to FSlint, written in Rust.
|
||||
This is my first ever project in Rust so probably a lot of things are not being written in the most optimal way.
|
||||
|
||||
|
||||
|
||||
## Why?
|
||||
In internet exists a lot of tools to find duplicates, empty folders, temporary files etc. but in most cases there are only available on CLI, which is hard to use by users.
|
||||
There's a lot of tools to find duplicates, empty folders, temporary files etc. on the Internet, but in most cases these are only available as CLI, which is hard to use by users.
|
||||
|
||||
GUI FSlint allows to really easy select different files and folders, but is based on old and unsupported Python 2 and GTK 2.
|
||||
GUI FSlint allows to select different files and folders easily, but is based on old and unsupported Python 2 and GTK 2.
|
||||
|
||||
Other tools are mostly written in C/C++ to provide big performance but still needs to be tested a lot if not contains memory leaks, invalid memory reads/write and double frees.
|
||||
Other tools are mostly written in C/C++ for high performance but still need to be tested a lot for memory leaks, invalid memory reads/writes and double frees.
|
||||
|
||||
But the most important thing for me was to learn Rust and create a program useful for the open source community.
|
||||
|
||||
## Features
|
||||
- Written in fast and memory safe Rust
|
||||
- CLI frontend, very fast and powerful with rich help
|
||||
- GUI GTK frontend - use modern GTK 3 and looks similar to FSlint
|
||||
- GUI GTK frontend - uses modern GTK 3 and looks similar to FSlint
|
||||
- Light/Dark theme match the appearance of the system
|
||||
- GUI Orbtk frontend(Very early WIP) - alternative GUI with reduced functionality
|
||||
- Saving results to file - allows to easily read entries found by tool
|
||||
- Rich search option - allows setting absolute included and excluded directories, set of allowed files extensions or excluded items with * wildcard
|
||||
- Saving results to a file - allows reading entries found by the tool easily
|
||||
- Rich search option - allows setting absolute included and excluded directories, set of allowed file extensions or excluded items with * wildcard
|
||||
- Clean Glade file in which UI can be easily modernized
|
||||
- Multiple tools to use:
|
||||
- Duplicates - Finds duplicates basing on its size(fast), hash(accurate), first 1MB of hash(moderate)
|
||||
- Empty Folders - Finds empty folders with help of advanced algorithm
|
||||
- Duplicates - Finds duplicates basing on size(fast), hash(accurate), first 1MB of hash(moderate)
|
||||
- Empty Folders - Finds empty folders with the help of advanced algorithm
|
||||
- Big Files - Finds provided number of the biggest files in given location
|
||||
- Empty Files - Looks for empty files across disk
|
||||
- Temporary Files - Allows finding temporary files
|
||||
|
||||
## Usage and requirements
|
||||
### Requirements
|
||||
For normal use of the program, the only requirements for is having GTK 3.22+.
|
||||
For CLI, Orbtk on all OS and GTK GUI on Windows, there is no special requirements.
|
||||
For normal use of the program, the only requirement is having GTK 3.22+.
|
||||
For CLI, Orbtk on all OS and GTK GUI on Windows, there are no special requirements.
|
||||
|
||||
Precompiled binaries are here - https://github.com/qarmin/czkawka/releases/
|
||||
|
||||
You can also application with every single commit here - https://github.com/qarmin/czkawka/actions
|
||||
You can also browse application workflows with every single commit here - https://github.com/qarmin/czkawka/actions
|
||||
|
||||
If app not working when clicking at it, run it by terminal.
|
||||
If the app is not launching when clicking at a launcher, run it through a terminal.
|
||||
### Cargo
|
||||
You can really fast install Czkawka from Cargo by typing `cargo install czkawka_gui`
|
||||
You can install Czkawka quickly from Cargo by typing `cargo install czkawka_gui`
|
||||
|
||||
### Snap, Flatpak, Appimage
|
||||
Still WIP, but looking for help
|
||||
|
||||
### AUR - Arch Linux Package
|
||||
Czkawka is also available in Arch Linux AUR from which it can be simple downloaded and installed on OS.
|
||||
Czkawka is also available in Arch Linux AUR from which it can be simply downloaded and installed on the system.
|
||||
```
|
||||
yay -Syu czkawka-git
|
||||
```
|
||||
|
||||
## Compilation
|
||||
### Requirements
|
||||
|
|
@ -62,7 +65,7 @@ apt install -y libgtk-3-dev
|
|||
```
|
||||
|
||||
### Compilation from source
|
||||
- Download source
|
||||
- Download the source
|
||||
```
|
||||
git clone https://github.com/qarmin/czkawka.git
|
||||
cd czkawka
|
||||
|
|
@ -71,7 +74,7 @@ cd czkawka
|
|||
```
|
||||
cargo run --bin czkawka_gui
|
||||
```
|
||||
For Linux to Windows cross-building instruction look at the CI.
|
||||
For Linux-to-Windows cross-building instruction look at the CI.
|
||||
|
||||
- Run alternative Orbtk GUI(Still WIP, currently stopped due https://github.com/intellij-rust/intellij-rust/issues/5943)
|
||||
|
||||
|
|
@ -86,30 +89,30 @@ cargo run --bin czkawka_cli
|
|||
|
||||
|
||||
## Speed
|
||||
Since Czkawka is written in Rust and aims to be a faster alternative for written in Python - FSlint we need to compare speed of this two tools.
|
||||
Since Czkawka is written in Rust and aims to be a faster alternative for FSlint written in Python, we need to compare speed of these two tools.
|
||||
|
||||
I checked prepared before directory, without any folder exceptions(I removed all directories from FSlint and Czkawka from other tabs than Include Directory) which contained 176 056 files and 22194 folders and 88436 duplicated files in 52330 groups which took 6,2 GB.
|
||||
I prepared a directory and performed a check without any folder exceptions(I removed all directories from FSlint and Czkawka from other tabs than Include Directory) which contained 176 056 files and 22194 folders and 88436 duplicated files in 52330 groups which took 6,2 GB.
|
||||
|
||||
First run reads file entry and save it to cache so this step is mostly limited by disk performance, and with second run cache helps it so searching is sometimes faster(with a small amount of duplicates is even 10x faster).
|
||||
The first run reads the file entry and caches it so this step is mostly limited by disk performance. In the second run the cache helps so searching is sometimes faster(with a small amount of duplicates it's even 10x faster).
|
||||
|
||||
Duplicate Checker(Version 0.1.4)
|
||||
|
||||
| App| Executing Time |
|
||||
|:----------:|:-------------:|
|
||||
| Fslint (First Run)| 284s |
|
||||
| Fslint (Second Run)| 247s |
|
||||
| FSlint (First Run)| 284s |
|
||||
| FSlint (Second Run)| 247s |
|
||||
| Czkawka GUI Release(First Run) | 118s |
|
||||
| Czkawka GUI Release(Second Run) | 120s |
|
||||
|
||||
For Fslint I used Mprof and for Czkawka Heaptrack
|
||||
I used Mprof for FSlint and Heaptrack for Czkawka
|
||||
|
||||
| App| Idle Ram | Max Operational Ram Usage | Stabilized after search usage |
|
||||
|:----------:|:-------------:|:-------------:|:-------------:|
|
||||
| Fslint | 55 MB | 160 MB | 150 MB |
|
||||
| FSlint | 55 MB | 160 MB | 150 MB |
|
||||
| Czkawka GTK GUI Release | 8 MB | 76 MB | 75 MB |
|
||||
|
||||
|
||||
Differences should be more visible when using slower processor or faster disk.
|
||||
Differences should be more visible when using slower CPU or faster disk.
|
||||
|
||||
## Comparsion with FSLint
|
||||
|
||||
|
|
@ -138,20 +141,20 @@ Contributions to this repository are welcome.
|
|||
You can help by creating:
|
||||
- Bug report - memory leaks, unexpected behavior, crashes
|
||||
- Feature proposals - proposal to change/add/delete some features
|
||||
- Pull Requests - implementing by yourself a new feature or fixing bugs, but also important is code quality. If change is bigger, then is good to open new issue to discuss changes.
|
||||
- Pull Requests - implementing a new feature yourself or fixing bugs, but code quality is also important. If a change is bigger, then it's a good idea to open a new issue to discuss changes.
|
||||
|
||||
Code should be clean and pretty formatted (Clippy and fmt are required in each PR).
|
||||
Code should be clean and well formatted (Clippy and fmt are required in each PR).
|
||||
|
||||
Code should also be easy to read so please use as much simplest language as possible without magic numbers and variables with strange names, and try to write unit tests/tests if possible.
|
||||
Code should also be easy to read so please use the simplest possible language without magic numbers and variables with strange names; try to write unit tests if possible.
|
||||
|
||||
## Name
|
||||
Czkawka is a Polish word which means hiccup.
|
||||
Czkawka is a Polish word which means _hiccup_.
|
||||
I chose this name because I wanted to hear people speaking other languages pronounce it.
|
||||
This name is not as bad as it seems, because I was also thinking about using words like żółć, gżegżółka czy żołądź, but I gave up these ideas because of having Polish characters, which would be a huge difficulty in searching for a project.
|
||||
This name is not as bad as it seems, because I was also thinking about using words like _żółć_, _gżegżółka_ or _żołądź_, but I gave up on these ideas due to them having Polish characters, which would be a huge difficulty in searching for a project.
|
||||
|
||||
## License
|
||||
Code is distributed under MIT license.
|
||||
|
||||
Program is completely free to use.
|
||||
|
||||
"Gratis to uczciwa cena" - "Free is a fair price"
|
||||
"Gratis to uczciwa cena" - "Free is a fair price"
|
||||
|
|
|
|||
Loading…
Reference in a new issue