From b1e5693d5b520552c2f683f5b4585a83fb2d4c81 Mon Sep 17 00:00:00 2001
From: Daniel Liu <mr.picklepinosaur@gmail.com>
Date: Sun, 14 Feb 2021 19:16:45 -0500
Subject: [PATCH] readme

---
 README       | 40 ----------------------------------------
 README.md    | 33 +++++++++++++++++++++++++++++++++
 config.def.h |  2 +-
 3 files changed, 34 insertions(+), 41 deletions(-)
 delete mode 100644 README
 create mode 100644 README.md

diff --git a/README b/README
deleted file mode 100644
index da4577f..0000000
--- a/README
+++ /dev/null
@@ -1,40 +0,0 @@
-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
-
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..cb6ca30
--- /dev/null
+++ b/README.md
@@ -0,0 +1,33 @@
+## surf - simple webkit-based browser
+pinosaur's patched version surf from suckless.
+
+The following patches are applied:
+- [bookmarking](https://surf.suckless.org/patches/bookmarking/)
+- [homepage](https://surf.suckless.org/patches/homepage/)
+- [search engine](https://surf.suckless.org/patches/searchengines/)
+- [playexternal](https://surf.suckless.org/patches/playexternal/)
+
+### 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).
+
+Then run the following:
+```
+make && sudo make clean install
+```
+
+### Running surf in tabbed
+For running surf in tabbed 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.
diff --git a/config.def.h b/config.def.h
index bb2b4a9..441ac52 100644
--- a/config.def.h
+++ b/config.def.h
@@ -216,4 +216,4 @@ static Button buttons[] = {
 	{ OnMedia,      MODKEY,         1,      clickexternplayer, { 0 },       1 },
 };
 
-#define HOMEPAGE "https://searx.danieliu.xyz/"
+#define HOMEPAGE "https://danieliu.xyz/"
-- 
2.20.1