docs: Documentation and minor changes
This commit is contained in:
39
README.md
Normal file
39
README.md
Normal file
@ -0,0 +1,39 @@
|
||||
# Papulastic image format
|
||||
|
||||
Simple image format encoded/decoder and metadata extractor from file format from some random documentation from school.
|
||||
|
||||
## How to use
|
||||
|
||||
Just compile the binary 💀
|
||||
|
||||
```bash
|
||||
cargo build --release
|
||||
```
|
||||
|
||||
Or if you wanna be menace to society you can run `cargo run` everytime.
|
||||
|
||||
## Encoding
|
||||
|
||||
```bash
|
||||
papulastic-image-format encode --input INPUT -o OUTPUT
|
||||
```
|
||||
|
||||
You can also include initials and custom signature
|
||||
|
||||
```bash
|
||||
papulastic-image-format encode -i INPUT -o OUTPUT --initials JK --signature FALSE-BLINDNESS
|
||||
```
|
||||
|
||||
## Decoding
|
||||
|
||||
```bash
|
||||
papulastic-image-format decode -i INPUT -o OUTPUT.png
|
||||
```
|
||||
|
||||
## Metadata
|
||||
|
||||
```bash
|
||||
papulastic-image-format metadata -i INPUT
|
||||
```
|
||||
|
||||
This code is not perfect but the documentation isn't too so I can't be bothered.
|
||||
Reference in New Issue
Block a user