summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorSoniEx2 <endermoneymod@gmail.com>2020-06-13 20:09:18 -0300
committerSoniEx2 <endermoneymod@gmail.com>2020-06-13 20:09:18 -0300
commitd36923df9778cccef8d8be0e64dca08f1c93874e (patch)
treeb1dbfce3596bf2b9e4850f0b6c7f79195f740304
parent2a32cde49e2723b7047c8ed908a009f9f881422c (diff)
Update docs
-rw-r--r--HACKING.md7
-rw-r--r--README.md8
2 files changed, 14 insertions, 1 deletions
diff --git a/HACKING.md b/HACKING.md
new file mode 100644
index 0000000..c7a92c2
--- /dev/null
+++ b/HACKING.md
@@ -0,0 +1,7 @@
+# Hacking HexArt
+
+This material guides you through hacking HexArt. It also serves as a high-level overview of the project.
+
+## Project Structure
+
+HexArt is built on LOVE2D. Currently everything is in `main.lua`.
diff --git a/README.md b/README.md
index 66389e2..159aa7f 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,12 @@
 # HexArt
 
-An hex-based paletted image ~~editor~~ creator.
+Yet another image editor.
+
+## Features
+
+HexArt is a paletted image editor.
+
+## Usage
 
 Keys: