Add README file

1 files changed, 43 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..0fecd1d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,43 @@
+# cdraw editor
+
+cdraw is a minimal pixel art sprite editor.
+
+## Features
+
+At the moment cdraw has the following features:
+- pen/eraser/fill tool
+- zooming in/out
+- color picker
+- custom palettes (although it will use only *def_palette_path*)
+- binary format for projects
+- importing/exporting
+
+And these features are waiting to be implemented:
+- custom tool cursor
+- undo/redo actions
+- layers + frames
+
+## Controls
+
+All the keybindings can be changed in *src/config.h*.
+
+- **=/-** for zooming in/out
+- **arrows** for moving the canvas
+- **S** save file (using terminal input)
+- **O** open file (using terminal input)
+- **SHIF+I** export image (using terminal input)
+- **SHIF+E** import image (using terminal input)
+- **B** select pencil
+- **E** select eraser
+- **F** select fill tool
+- **I** select color picker tool
+- **[/]** scroll through palette
+
+
+## Compiling
+
+SDL2 and SDL2_image dev files are needed for compiling.
+
+```sh
+make
+```