Add README

This commit is contained in:
sam 2025-03-08 11:47:34 +13:00
parent 1cc937d19f
commit 32e832d0f4

20
README.md Normal file
View 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>
```