Adding README file.

This commit is contained in:
Enno Boland (tox) 2009-09-11 08:18:09 +02:00
parent 44511e2549
commit f400f0d56f
2 changed files with 26 additions and 1 deletions

View File

@ -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

25
README Normal file
View File

@ -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]