Add README
This commit is contained in:
parent
1cc937d19f
commit
32e832d0f4
1 changed files with 20 additions and 0 deletions
20
README.md
Normal file
20
README.md
Normal file
|
@ -0,0 +1,20 @@
|
||||||
|
# Sand Image
|
||||||
|
This image format stores a seed and colors for pixel ids in a sand simulation
|
||||||
|
# Building
|
||||||
|
You need the odin compiler installed on your machine, there are releases if u dont want to install it
|
||||||
|
```
|
||||||
|
build.sh
|
||||||
|
```
|
||||||
|
or
|
||||||
|
```
|
||||||
|
build.bat
|
||||||
|
```
|
||||||
|
# Usage
|
||||||
|
You can convert images to sand images with
|
||||||
|
```
|
||||||
|
./converter <input image filename> <output image filename>
|
||||||
|
```
|
||||||
|
You can view sand images with
|
||||||
|
```
|
||||||
|
./viewer <sand image filename>
|
||||||
|
```
|
Loading…
Add table
Reference in a new issue