mirror of https://github.com/qarmin/czkawka
OS info
Rafał Mikrut
7 months ago
parent
d4dfd28790
commit
b70ab684cd
@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2020-2023 Rafał Mikrut
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@ -0,0 +1,41 @@
|
||||
# Czkawka CLI
|
||||
|
||||
CLI frontend, allows to use Czkawka from terminal.
|
||||
|
||||
## Requirements
|
||||
Precompiled binaries should work without any additional dependencies with Linux(Ubuntu 20.04+), Windows(10+) and macOS(10.15+).
|
||||
|
||||
If you decide to compile the app, you probably will be able to run it on even older versions of OS, like Ubuntu 16.04 or Windows 7.
|
||||
|
||||
On linux it is even possible with eyra to avoid entirely libc and using fully static rust binary.
|
||||
|
||||
If you want to use similar videos tool, you need to install ffmpeg(optional feature, only needed when running).
|
||||
- mac - `brew install ffmpeg` - https://formulae.brew.sh/formula/ffmpeg
|
||||
- linux - `sudo apt install ffmpeg`
|
||||
- windows - `choco install ffmpeg` - or if not working, download from https://ffmpeg.org/download.html#build-windows and unpack to location with `czkawka_cli.exe`
|
||||
|
||||
## Compilation
|
||||
For compilation, you need to have installed Rust via rustup - https://rustup.rs/ and compile it e.g. via
|
||||
```shell
|
||||
cargo run --release --bin czkawka_cli
|
||||
```
|
||||
|
||||
on linux to build fully static binary you need to use
|
||||
```shell
|
||||
rustup default nightly-2023-11-16 # or any newer nightly that works fine with eyra
|
||||
cd czkawka_cli
|
||||
cargo add eyra --rename=std
|
||||
echo 'fn main() { println!("cargo:rustc-link-arg=-nostartfiles"); }' > build.rs
|
||||
cd ..
|
||||
cargo build --release --bin czkawka_cli
|
||||
```
|
||||
|
||||
## Limitations
|
||||
Not all available features in core are available in CLI.
|
||||
|
||||
List of not available features:
|
||||
- Ability to use/choose referenced directories
|
||||
- See progress of scanning
|
||||
|
||||
## LICENSE
|
||||
MIT
|
||||
@ -0,0 +1,21 @@
|
||||
MIT License
|
||||
|
||||
Copyright (c) 2020-2023 Rafał Mikrut
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
@ -0,0 +1,3 @@
|
||||
# Czkawka Core
|
||||
|
||||
Core of Czkawka GUI/CLI and Krokiet projects.
|
||||
@ -0,0 +1,68 @@
|
||||
# Czkawka GUI
|
||||
Czkawka GUI is a graphical user interface for Czkawka Core written with GTK 4.
|
||||
|
||||
## Requirements
|
||||
Requirements depends on platform that you are using:
|
||||
### Linux
|
||||
#### Prebuild binaries
|
||||
Ubuntu - `sudo apt install libgtk-4 libheif ffmpeg -y`
|
||||
#### Snap -
|
||||
none - all needed libraries are bundled in snap - except ffmpeg https://github.com/snapcrafters/ffmpeg/issues/73
|
||||
#### Flatpak
|
||||
none - all needed libraries are bundled
|
||||
### Mac
|
||||
```
|
||||
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
|
||||
brew install gtk4 adwaita-icon-theme ffmpeg librsvg libheif
|
||||
```
|
||||
|
||||
### Windows
|
||||
All needed libraries should be bundled in zip(except ffmpeg which you need download and unpack to location with `czkawka_gui.exe` - https://ffmpeg.org/download.html#build-windows)
|
||||
|
||||
|
||||
| Program | Minimal version |
|
||||
|:---------:|:-----------------:|
|
||||
| Rust | 1.72.1 |
|
||||
| GTK | 4.6 |
|
||||
|
||||
Prebuild binaries - https://github.com/qarmin/czkawka/releases/ </br>
|
||||
Snap package - https://snapcraft.io/czkawka </br>
|
||||
Flatpak package - https://flathub.org/apps/com.github.qarmin.czkawka </br>
|
||||
|
||||
## Compilation
|
||||
Compilation of gui is harder that compilation cli or core, because uses gtk4 which is written in C and also requires a lot build and runtime dependencies.
|
||||
|
||||
### Linux (Ubuntu, but on other OS should work similar)
|
||||
```shell
|
||||
sudo apt install libgtk-4-dev libheif-dev -y
|
||||
cargo run --release --bin czkawka_gui
|
||||
```
|
||||
### Mac
|
||||
```shell
|
||||
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
|
||||
brew install rustup gtk4 adwaita-icon-theme ffmpeg librsvg libheif pkg-config
|
||||
rustup-init
|
||||
cargo run --release --bin czkawka_gui
|
||||
```
|
||||
### Windows
|
||||
Currently, it is not possible to compile app natively on Windows, but is possible to cross-compile it from Linux.</br>
|
||||
You can check for CI for instructions how to cross-compile app(uses prebuilt docker image) - [CI Instructions](../.github/workflows/windows.yml)
|
||||
|
||||
## Limitations
|
||||
Not all available features in core are available in GUI and also there are limitations between platforms:
|
||||
- Snap versions not allows to use similar videos feature
|
||||
- Windows version not supports heif and webp files
|
||||
- Prebuild binaries for mac arm not exists
|
||||
|
||||
## License
|
||||
Code is distributed under MIT license.
|
||||
|
||||
Icon was created by [jannuary](https://github.com/jannuary) and licensed CC-BY-4.0.
|
||||
|
||||
Windows dark theme is used from project [WhiteSur](https://github.com/slypy/whitesur-gtk4-theme) with MIT license.
|
||||
|
||||
Some icons were taken from [ReShot](https://www.reshot.com) site and are licensed under Reshot Free License.
|
||||
|
||||
The program is completely free to use.
|
||||
|
||||
"Gratis to uczciwa cena" - "Free is a fair price"
|
||||
Loading…
Reference in New Issue