X-Git-Url: https://git.danieliu.xyz/?p=surf.git;a=blobdiff_plain;f=README;fp=README;h=0535a5c0fffaa274f374ff7fc7279f64147b49cc;hp=0000000000000000000000000000000000000000;hb=f400f0d56f9a89984b40f5b8a57e410c0bf2c9e2;hpb=44511e25490498bc2a38adcfda1f4f6e25805d7a

diff --git a/README b/README
new file mode 100644
index 0000000..0535a5c
--- /dev/null
+++ b/README
@@ -0,0 +1,25 @@
+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.
+
+
+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 [URL]