summaryrefslogtreecommitdiff
path: root/INSTALL
blob: 65a948e04c201c24aa994169462e6a8c5daa47f0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
Readable is written in ECMAScript, and how to launch it varies a
little depending on browser.

# Firefox

Readable is now packaged as an extension for firefox (and other
browsers of its kin.) You can either get it from the readable web
page, or build it by running:

	make xpi


# Chromium

Readable also exists as an extension for chromium (and derived
browsers.) It isn't currently available on the "extensions gallery,"
but if someone wants to post it there, please go ahead. For now
you can get it from the readable web page, or by running:

	make crx

# Surf

To use readable from surf, and trigger it from ctrl-alt-r, add the
following to script.js

(function() {
	document.addEventListener('keydown', keybind, false);
})();

function keybind(e) {
	if (e.keyIdentifier == "U+0052" && e.ctrlKey && e.altKey) // ctrl-alt-r
		readable();
}
/* copy readable.js here */


# Uzbl

To use this from uzbl, add the following line to the config file:

@cbind r = script file:///path/to/readable.js

You'll also have to add the statement 'readable();' to the bottom of
readable.js.


# Other browsers; 'bookmarklet'

To use this as a 'bookmarklet', create a new bookmark with an address of:

javascript:(function(){document.body.appendChild(document.createElement('script')).src='file:///path/to/readable.js';})();javascript:(function(){readable();})();

Note that due to browsers being afraid of mixing local and remote files
this may not work for http:// addresses. If this is the case, you can
either run the script from a remote location (eg your webserver), or
integrate it into a browser-specific extension.