X-Git-Url: https://git.danieliu.xyz/?p=surf.git;a=blobdiff_plain;f=README.md;fp=README.md;h=cb6ca304c3b4d713d838af75fcea6e5e9a430990;hp=0000000000000000000000000000000000000000;hb=b1e5693d5b520552c2f683f5b4585a83fb2d4c81;hpb=1f04725ac4e99f377d90b21e487a5d019fafda08

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cb6ca30
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+## surf - simple webkit-based browser
+pinosaur's patched version surf from suckless.
+
+The following patches are applied:
+- [bookmarking](https://surf.suckless.org/patches/bookmarking/)
+- [homepage](https://surf.suckless.org/patches/homepage/)
+- [search engine](https://surf.suckless.org/patches/searchengines/)
+- [playexternal](https://surf.suckless.org/patches/playexternal/)
+
+### Requirements
+In order to build surf you need GTK+ and Webkit/GTK+ header files.
+
+In order to use the functionality of the url-bar, also install dmenu[0].
+
+### Installation
+
+Edit config.mk to match your local setup (surf is installed into
+the /usr/local namespace by default).
+
+Then run the following:
+```
+make && sudo make clean install
+```
+
+### Running surf in tabbed
+For running surf in tabbed there is a script included in the distribution,
+which is run like this:
+```
+surf-open.sh [URI]
+```
+
+Further invocations of the script will run surf with the specified URI in this
+instance of tabbed.