From: Enno Boland (tox) <tox@s01.de>
Date: Fri, 11 Sep 2009 06:18:09 +0000 (+0200)
Subject: Adding README file.
X-Git-Url: https://git.danieliu.xyz/?p=surf.git;a=commitdiff_plain;h=f400f0d56f9a89984b40f5b8a57e410c0bf2c9e2

Adding README file.
---

diff --git a/Makefile b/Makefile
index 327514d..80fe821 100644
--- a/Makefile
+++ b/Makefile
@@ -35,7 +35,7 @@ clean:
 dist: clean
 	@echo creating dist tarball
 	@mkdir -p surf-${VERSION}
-	@cp -R LICENSE Makefile config.mk \
+	@cp -R LICENSE Makefile config.mk README \
 		surf.1 ${SRC} surf-${VERSION}
 	@tar -cf surf-${VERSION}.tar surf-${VERSION}
 	@gzip surf-${VERSION}.tar
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]