From 9a344b63e899dcf90070e0fe8cef141f9c703f56 Mon Sep 17 00:00:00 2001
From: Julian Ospald <hasufell@hasufell.de>
Date: Sun, 20 Dec 2015 00:57:34 +0100
Subject: [PATCH] DOCS: add README.md and HACKING.md

---
 HACKING.md | 29 +++++++++++++++++++++++++++++
 README.md  | 25 +++++++++++++++++++++++++
 2 files changed, 54 insertions(+)
 create mode 100644 HACKING.md
 create mode 100644 README.md

diff --git a/HACKING.md b/HACKING.md
new file mode 100644
index 0000000..9771d3e
--- /dev/null
+++ b/HACKING.md
@@ -0,0 +1,29 @@
+HACKING
+=======
+
+Coding style
+------------
+
+- match the sorroundings
+- no overcomplicated pointfree style
+- normal indenting 2 whitespaces
+- just make things pretty and readable
+
+Documentation
+-------------
+
+__Everything__ must be documented. :)
+
+Hacking Guide
+-------------
+
+The main data structure is in [DirTree.hs](src/Data/DirTree.hs), which
+should be seen as a library. This is then mapped into the Gtk+ GUI at
+[Gui.hs](src/GUI/Gtk/Gui.hs) and [Utils.hs](src/GUI/Gtk/Utils.hs).
+
+File operations (like copy, delete etc) are defined at
+[File.hs](src/IO/File.hs).
+
+Note that the main data structures are still a bit in flux. Join
+[the discussion](https://github.com/hasufell/hsfm/issues/12) on how to
+improve them.
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..13e46ca
--- /dev/null
+++ b/README.md
@@ -0,0 +1,25 @@
+HSFM
+====
+
+A Gtk+:3 filemanager written in Haskell.
+
+Design goals:
+
+- easy to use
+- useful library interface to be able to build other user interfaces
+- type safety, runtime safety, strictness
+- simple add-on interface
+
+
+Installation
+------------
+
+```
+cabal install
+```
+
+
+Contributing
+------------
+
+See [HACKING.md](HACKING.md).