feat: initialize project
This commit is contained in:
@@ -0,0 +1,33 @@
|
||||
# Nordify (Rust)
|
||||
|
||||
A Rust reimplementation of
|
||||
[nordify](https://github.com/kikefdezl/nordify), a tool that converts
|
||||
images to the [Nord](https://www.nordtheme.com/) palette without
|
||||
dithering artifacts.
|
||||
|
||||
> [!NOTE]
|
||||
> This project is in its infancy and probably not correct yet.
|
||||
|
||||
## Why a Rust rewrite?
|
||||
|
||||
The original `nordify` is written in Python. The original project aims
|
||||
to provide the same image conversion, without the artifacts typical of
|
||||
naive dithering algorithms, as a fast, dependency-light single Rust
|
||||
binary.
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
cargo run --release -- input.png -o output.png
|
||||
```
|
||||
|
||||
## Development
|
||||
|
||||
```bash
|
||||
cargo build
|
||||
cargo test
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
GPL-3.0-or-later
|
||||
Reference in New Issue
Block a user