Cleanup documentation

[frida/frida.git] / README

diff --git a/README b/README
new file mode 100644 (file)
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: