readme
[surf.git] / README.md
1 ## surf - simple webkit-based browser
2 pinosaur's patched version surf from suckless.
3
4 The following patches are applied:
5 - [bookmarking](https://surf.suckless.org/patches/bookmarking/)
6 - [homepage](https://surf.suckless.org/patches/homepage/)
7 - [search engine](https://surf.suckless.org/patches/searchengines/)
8 - [playexternal](https://surf.suckless.org/patches/playexternal/)
9
10 ### Requirements
11 In order to build surf you need GTK+ and Webkit/GTK+ header files.
12
13 In order to use the functionality of the url-bar, also install dmenu[0].
14
15 ### Installation
16
17 Edit config.mk to match your local setup (surf is installed into
18 the /usr/local namespace by default).
19
20 Then run the following:
21 ```
22 make && sudo make clean install
23 ```
24
25 ### Running surf in tabbed
26 For running surf in tabbed there is a script included in the distribution,
27 which is run like this:
28 ```
29 surf-open.sh [URI]
30 ```
31
32 Further invocations of the script will run surf with the specified URI in this
33 instance of tabbed.