Add README and update ignore

chaojian-zhang · Dec 18, 2019 · 9a31d6a · 9a31d6a
1 parent 833a911
commit 9a31d6a
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -337,4 +337,7 @@ ASALocalRun/
 .localhistory/
 
 # BeatPulse healthcheck temp database
-healthchecksdb
+healthchecksdb
+
+# Generated
+BinaryOutput
diff --git a/README.md b/README.md
@@ -0,0 +1,7 @@
+# Magica Voxel Writer
+
+A c# program/library/snippet to write to MagicaVoxel's `.vox` file.
+
+Two versions are provided in **VoxWriter.cs** and **VoxWriterClean.cs**, with former using bitwise operations and latter use more object-oriented approach. The program is adapted from https://codepen.io/quasimondo/pen/QjqZvV
+
+See **Example.cs** for usage.