From a066bc221527cb9d48ab669c21da2b36f0364bda Mon Sep 17 00:00:00 2001
From: Christoph Egger <christoph@christoph-egger.org>
Date: Tue, 26 May 2015 21:51:53 +0200
Subject: [PATCH] Cleanup documentation

---
 README         | 32 ++++++++++++++++++++++++++++++++
 doc/BUGS.org   | 15 ---------------
 doc/README.org | 12 ------------
 3 files changed, 32 insertions(+), 27 deletions(-)
 create mode 100644 README
 delete mode 100644 doc/BUGS.org
 delete mode 100644 doc/README.org

diff --git a/README b/README
new file mode 100644
index 0000000..a862f60
--- /dev/null
+++ b/README
@@ -0,0 +1,32 @@
+FrIDa
+=====
+
+Building
+--------
+
+FrIDa uses cmake. To build it you can do the following
+
+.. code-block::
+   bash
+
+   mkdir build
+   cd build
+   cmake -DCMAKE_BUILD_TYPE=Release ..
+   make -j
+   make install
+
+If you do not want to install frida, you can runn it locally. However
+you need to add the ``build`` directory to ``LD_LIBRARY_PATH``
+
+For details refer to https://doc.frida.xyz
+
+Bug Reports
+-----------
+
+Bugs can be reported at https://projects.faui2k9.de/tag/frida/ or via
+mail to christoph@frida.xyz
+
+..
+   Local Variables:
+   mode: rst
+   End:
diff --git a/doc/BUGS.org b/doc/BUGS.org
deleted file mode 100644
index b8191ca..0000000
--- a/doc/BUGS.org
+++ /dev/null
@@ -1,15 +0,0 @@
-* TODO BasicBlockWidget should get an unique type
-
-    As a result, properly filter BasicBlockWidgets when spacing
-    without linearly searching through all BasicBlockWidgets all the
-    time
-
-* DONE Splitting BasicBlocks needs to happen sooner
-
-    BasicBlocks are splittet too late these days. As a result we
-    sometimes get BasicBlocks that are suffixes of other BasicBlocks
-
-* TODO spread out enries
-
-    Add some small gap between inbound edges the currently layout is
-    slightly confusing
diff --git a/doc/README.org b/doc/README.org
deleted file mode 100644
index 6b2738d..0000000
--- a/doc/README.org
+++ /dev/null
@@ -1,12 +0,0 @@
-
-* Building FRIDA
-
-On Debian Systems you will need the following packages apart fro
-`build-essential`:
-
- + cmake
- + qtbase5-dev
- + llvm-3.5-dev
- + liblog4cxx10-dev
- + clang (>= 3.3) -- or change compiler to g++
- + pkg-config
-- 
2.39.5