summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md61
1 files changed, 22 insertions, 39 deletions
diff --git a/README.md b/README.md
index 6d685a6..2ba53c6 100644
--- a/README.md
+++ b/README.md
@@ -3,10 +3,11 @@ Miguel's Surfing Quick Links
This repo holds the buggy fruit of my nightly struggle with WebKit2GTK+
and allows me following links quickly, keyboard-only.
-The by far biggest limitation by now is, that the shared memory area
-only holds the links of the last loaded website, which renders it nearly
-useless for multi-tab scenarios or when running multiple instances of
-the browser.
+This repo contains also the suckless surf browser which this extension
+was tested against.
+
+For adaptions of surf itself diff with upstream version on suckless:
+surf commit 81f0452bc6c2a110239fa303ad1e72f11c33dc94 from htps://git.suckless.org/surf
![Screenshot](https://raw.githubusercontent.com/miguelclean/surf-webext-dom/master/shot.png) "Screenshot of suckless's surf running quick links"
@@ -14,39 +15,21 @@ Contribute
==========
Any contributions or pull requests (from any git repo) are warmly welcome.
-Installing this webkit2gtk+ extension
-=====================================
-* READ surf-webext-dom.c !!
-* adapt config.mk
+Installing this webkit2gtk+ extension along surf
+================================================
+* READ sources
+* adapt config.mk if required
* make
-* sudo make install
-
-Example: Using it with suckless.org's surf browser
-==================================================
-* adapt surf/config.h and surf/surf.c (see below)
-* recompile and rerun surf
-* have fun!
-
-adapting your surf/config.h
----------------------------
-Since I also changed my surf to multi-modal I use the number keys straight
-for the quick links like this:
-
- //domlinks (99=magic number / follow link)
- { 0, GDK_KEY_0, domlinks, { .i = 0 } },
- { 0, GDK_KEY_1, domlinks, { .i = 1 } },
- { 0, GDK_KEY_2, domlinks, { .i = 2 } },
- { 0, GDK_KEY_3, domlinks, { .i = 3 } },
- { 0, GDK_KEY_4, domlinks, { .i = 4 } },
- { 0, GDK_KEY_5, domlinks, { .i = 5 } },
- { 0, GDK_KEY_6, domlinks, { .i = 6 } },
- { 0, GDK_KEY_7, domlinks, { .i = 7 } },
- { 0, GDK_KEY_8, domlinks, { .i = 8 } },
- { 0, GDK_KEY_9, domlinks, { .i = 9 } },
- { 0, GDK_KEY_space, domlinks, { .i = 99 } },
-
-
-adapting your surf/surf.c
----------------------------
-surf.c needs an extra function 'domlinks' and two includes for IPC.
-Consult the surf.c.diff for details
+* make webext-build
+* sudo make webext-install #puts the webext-piper.so, where surf looks for it.
+* ./surf [url]
+
+Keys
+=====
+Since I use surf in modal mode (I hacked together):
+
+f - toggle links
+numbers - follow links(after you press 3 of them)
+
+You can adapt this in the config.h
+