From f33e0d721d881792720a9c4a8943d962e1cd2a5f Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?J=C3=A9r=C3=A9my=20Zurcher?= <jeremy@asynk.ch>
Date: Thu, 9 Jul 2020 14:23:41 +0200
Subject: add README

---
 .gitignore   |   1 +
 README.md    |  22 ++++++++++++++++++++++
 data/los.png | Bin 0 -> 74575 bytes
 3 files changed, 23 insertions(+)
 create mode 100644 README.md
 create mode 100644 data/los.png

diff --git a/.gitignore b/.gitignore
index e4fdbdb..7aa09f9 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1 +1,2 @@
+*~
 *.import
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cd7300d
--- /dev/null
+++ b/README.md
@@ -0,0 +1,22 @@
+# godot-hexgrid
+
+is a [godot](https://godotengine.org/) based framework to build classical hex boardgames.
+
+code is based on [gdx-boardgame](https://github.com/jeremyz/gdx-boardgame),
+which is based on [rustanddust](https://github.com/jeremyz/rustanddust).
+
+base map made with [gimp](https://www.gimp.org) and my plugin [hexmap](https://github.com/jeremyz/hexmap)
+
+## features
+
+    - [x] Distance
+    - [ ] Adjacents
+    - [x] Line Of Sight
+    - [ ] Reachable Tiles ::: BFS
+    - [ ] Shortest Path ::: A*
+    - [ ] Range Of Influence (LOS - Fire Power)
+    - [ ] Battle lines (Kruskal + farthest apart units are the flank units)
+
+## screenshots
+
+![Line Of Sight - Move](data/los.png)
diff --git a/data/los.png b/data/los.png
new file mode 100644
index 0000000..1e7929f
Binary files /dev/null and b/data/los.png differ
-- 
cgit v1.1-2-g2b99