From a54d55ee3f62b09429b18d0605c65b9446ea6b54 Mon Sep 17 00:00:00 2001
From: fenze <contact@fenze.dev>
Date: Mon, 9 May 2022 23:05:11 +0200
Subject: [PATCH] add readme

---
 readme | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 readme

diff --git a/readme b/readme
new file mode 100644
index 0000000..f0151b1
--- /dev/null
+++ b/readme
@@ -0,0 +1,22 @@
+rose browser
+------------
+
+Simple webkitgtk browser.
+
+requirements
+------------
+
+In order to build surf you need gtk4 and webkit2gtk-5.0.
+
+In order to use the functionalities:
+  - video support: gst-libav, gst-plugins-good
+  - url bar: dmenu
+  - tabs: tabbed
+
+installation
+------------
+
+Run following command to build and install
+(if necessary as root):
+
+  make clean install