summaryrefslogtreecommitdiff
path: root/surf/README
diff options
context:
space:
mode:
authorstkhan <personal@slickd.xyz>2022-04-21 17:15:27 -0500
committerstkhan <personal@slickd.xyz>2022-04-21 17:15:27 -0500
commit6d5f8c137608df2e459c9865efa19c72856ed6e8 (patch)
treebde7ebb7e20ac737d10c25b6503228395645a8db /surf/README
parentdf966cab682c913e8b62b460c9ef900e1046863f (diff)
added stuff:
Diffstat (limited to 'surf/README')
-rw-r--r--surf/README40
1 files changed, 40 insertions, 0 deletions
diff --git a/surf/README b/surf/README
new file mode 100644
index 0000000..da4577f
--- /dev/null
+++ b/surf/README
@@ -0,0 +1,40 @@
+surf - simple webkit-based browser
+==================================
+surf is a simple Web browser based on WebKit/GTK+.
+
+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).
+
+Afterwards enter the following command to build and install surf (if
+necessary as root):
+
+ make clean install
+
+Running surf
+------------
+run
+ surf [URI]
+
+See the manpage for further options.
+
+Running surf in tabbed
+----------------------
+For running surf in tabbed[1] 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.
+
+[0] http://tools.suckless.org/dmenu
+[1] http://tools.suckless.org/tabbed
+