first commit

1 files changed, 39 insertions, 0 deletions

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..ee60c72
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+Miguel's Surfing Quick Links
+============================
+
+Installing this webkit2gtk+ extension
+-------------------------------------
+* READ surf-webext-dom.c  !!
+* adapt config.mk
+* make
+* sudo make install
+
+Using it from surf
+------------------
+* 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