From 3d293ecb997547ce48ab5ee3c6a83effddbbb0ae Mon Sep 17 00:00:00 2001 From: Nick White Date: Sat, 13 Nov 2010 18:54:00 +0000 Subject: Rename to simplyread to avoid name clash --- BUGS | 4 +- COPYING | 2 +- INSTALL | 24 ++++++------ Makefile | 20 +++++----- README | 12 +++--- TODO | 2 +- chromium/background.html | 4 +- chromium/manifest.json | 4 +- doap.ttl | 14 +++---- gecko/chrome.manifest | 4 +- gecko/chrome/content/readable.xul | 10 ----- gecko/chrome/content/simplyread.xul | 10 +++++ gecko/install.rdf | 8 ++-- readable.js | 75 ------------------------------------- simplyread.js | 75 +++++++++++++++++++++++++++++++++++++ webheader.html | 2 +- 16 files changed, 135 insertions(+), 135 deletions(-) delete mode 100644 gecko/chrome/content/readable.xul create mode 100644 gecko/chrome/content/simplyread.xul delete mode 100755 readable.js create mode 100755 simplyread.js diff --git a/BUGS b/BUGS index 512d7a8..85023d3 100644 --- a/BUGS +++ b/BUGS @@ -7,5 +7,5 @@ are disabled in firefox. Subsequent runs are fine. Presumably it's a bug in firefox; should report it to them. When run as a bookmarklet in firefox, the first run it hasn't registered -readable() by the time it is called. Subsequent runs work fine. This -occurs whether readable is in a separate javascript: clause or not. +simplyread() by the time it is called. Subsequent runs work fine. This +occurs whether simplyread is in a separate javascript: clause or not. diff --git a/COPYING b/COPYING index a1b8ecd..cf4e447 100644 --- a/COPYING +++ b/COPYING @@ -1,4 +1,4 @@ -Readable is Copyright 2010 Nick White. It is licensed under the +SimplyRead is Copyright 2010 Nick White. It is licensed under the GNU Affero General Public License version 3, or any later version. GNU AFFERO GENERAL PUBLIC LICENSE diff --git a/INSTALL b/INSTALL index 65a948e..59fe2cb 100644 --- a/INSTALL +++ b/INSTALL @@ -1,10 +1,10 @@ -Readable is written in ECMAScript, and how to launch it varies a +SimplyRead 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 +SimplyRead is now packaged as an extension for firefox (and other +browsers of its kin.) You can either get it from the SimplyRead web page, or build it by running: make xpi @@ -12,16 +12,16 @@ page, or build it by running: # Chromium -Readable also exists as an extension for chromium (and derived +SimplyRead 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: +you can get it from the SimplyRead web page, or by running: make crx # Surf -To use readable from surf, and trigger it from ctrl-alt-r, add the +To use SimplyRead from surf, and trigger it from ctrl-alt-r, add the following to script.js (function() { @@ -30,26 +30,26 @@ following to script.js function keybind(e) { if (e.keyIdentifier == "U+0052" && e.ctrlKey && e.altKey) // ctrl-alt-r - readable(); + simplyread(); } -/* copy readable.js here */ +/* copy simplyread.js here */ # Uzbl To use this from uzbl, add the following line to the config file: -@cbind r = script file:///path/to/readable.js +@cbind r = script file:///path/to/simplyread.js -You'll also have to add the statement 'readable();' to the bottom of -readable.js. +You'll also have to add the statement 'simplyread();' to the bottom of +simplyread.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();})(); +javascript:(function(){document.body.appendChild(document.createElement('script')).src='file:///path/to/simplyread.js';})();javascript:(function(){simplyread();})(); 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 diff --git a/Makefile b/Makefile index 026015b..1038850 100644 --- a/Makefile +++ b/Makefile @@ -1,15 +1,15 @@ -NAME = readable +NAME = simplyread VERSION = 0.2 index.html: doap.ttl README webheader.html @echo making webpage @cat < webheader.html > $@ @smu < README >> $@ - @echo '

Download Readable $(VERSION)
' >> $@ + @echo '

Download SimplyRead $(VERSION)
' >> $@ @echo 'GPG signature

' >> $@ - @echo '

Readable $(VERSION) for Firefox
' >> $@ + @echo '

SimplyRead $(VERSION) for Firefox
' >> $@ @echo 'GPG signature

' >> $@ - @echo '

Readable $(VERSION) for Chromium
' >> $@ + @echo '

SimplyRead $(VERSION) for Chromium
' >> $@ @echo 'GPG signature

' >> $@ @echo '
' >> $@ @sh summary.sh doap.ttl | smu >> $@ @@ -17,7 +17,7 @@ index.html: doap.ttl README webheader.html dist: @mkdir -p $(NAME)-$(VERSION) - @cp readable.js COPYING INSTALL README $(NAME)-$(VERSION) + @cp simplyread.js COPYING INSTALL README $(NAME)-$(VERSION) @tar -c $(NAME)-$(VERSION) | bzip2 -c > $(NAME)-$(VERSION).tar.bz2 @gpg -b < $(NAME)-$(VERSION).tar.bz2 > $(NAME)-$(VERSION).tar.bz2.sig @rm -rf $(NAME)-$(VERSION) @@ -25,12 +25,12 @@ dist: @ln -sf $(NAME)-$(VERSION).tar.bz2.sig latest.tar.bz2.sig @echo $(NAME)-$(VERSION).tar.bz2 $(NAME)-$(VERSION).tar.bz2.sig -xpi: readable.js gecko/install.rdf gecko/chrome.manifest gecko/chrome/content/readable.xul gecko/chrome/content/icon.svg +xpi: simplyread.js gecko/install.rdf gecko/chrome.manifest gecko/chrome/content/simplyread.xul gecko/chrome/content/icon.svg @rm -rf $(NAME)-$(VERSION).xpi gecko-build @mkdir -p gecko-build/chrome/content @cp COPYING gecko/chrome.manifest gecko-build/ - @cp gecko/chrome/content/readable.xul gecko-build/chrome/content/ - @cp readable.js gecko-build/chrome/content/readable.js + @cp gecko/chrome/content/simplyread.xul gecko-build/chrome/content/ + @cp simplyread.js gecko-build/chrome/content/simplyread.js @rsvg gecko/chrome/content/icon.svg gecko-build/chrome/content/icon.png @sed "s/VERSION/$(VERSION)/g" < gecko/install.rdf > gecko-build/install.rdf @cd gecko-build; zip -r ../$(NAME)-$(VERSION).xpi . 1>/dev/null @@ -38,10 +38,10 @@ xpi: readable.js gecko/install.rdf gecko/chrome.manifest gecko/chrome/content/re @rm -rf gecko-build @echo $(NAME)-$(VERSION).xpi $(NAME)-$(VERSION).xpi.sig -crx: readable.js chromium/icon.svg chromium/manifest.json chromium/background.html +crx: simplyread.js chromium/icon.svg chromium/manifest.json chromium/background.html @rm -rf chromium-build @mkdir chromium-build - @cp COPYING readable.js chromium/background.html chromium-build/ + @cp COPYING simplyread.js chromium/background.html chromium-build/ @rsvg chromium/icon.svg chromium-build/icon.png @sed "s/VERSION/$(VERSION)/g" < chromium/manifest.json > chromium-build/manifest.json @chromium-browser --pack-extension=chromium-build diff --git a/README b/README index 6c8357e..e8240c8 100644 --- a/README +++ b/README @@ -1,13 +1,13 @@ -Readable -======== +SimplyRead +========== -Readable is a simple program to remove unwanted distractions from -webpages, in order to better enjoy reading on the web. It removes -everything but the article from a webpage, displaying it +SimplyRead is a simple program to remove unwanted distractions +from webpages, in order to better enjoy reading on the web. It +removes everything but the article from a webpage, displaying it simply and attractively. Running the program multiple times switches between showing the -original page and the 'readable' version. +original page and the simple version. This project is technically inspired by Arc90's Readability, but aims to be much simpler, faster, and more usable. More diff --git a/TODO b/TODO index d5a07eb..77c2145 100644 --- a/TODO +++ b/TODO @@ -1,10 +1,10 @@ -rename as there's already a similar program called readable. simply read seems good chromium extension http://code.google.com/chrome/extensions/index.html packaging http://code.google.com/chrome/extensions/packaging.html http://code.google.com/chrome/extensions/hosting.html http://code.google.com/chrome/extensions/crx.html use a simple script to create crx rather than chromium-browser + is the script src=simplyread in background.html necessary? handle signing extension properly epiphany extension http://projects.gnome.org/epiphany/extensions make tests, which process sample html files and check the output diff --git a/chromium/background.html b/chromium/background.html index 669ff78..229610d 100644 --- a/chromium/background.html +++ b/chromium/background.html @@ -1,5 +1,5 @@ - diff --git a/chromium/manifest.json b/chromium/manifest.json index 875c633..56c51fa 100644 --- a/chromium/manifest.json +++ b/chromium/manifest.json @@ -1,8 +1,8 @@ { - "name": "Readable", + "name": "SimplyRead", "version": "VERSION", "background_page": "background.html", "permissions": [ "tabs", "*://*/*" ], - "content_scripts": [{"matches": ["*://*/*"], "js": ["readable.js"]}], + "content_scripts": [{"matches": ["*://*/*"], "js": ["simplyread.js"]}], "browser_action": { "default_icon": "icon.png" } } diff --git a/doap.ttl b/doap.ttl index e85fe4a..4ebfb9d 100644 --- a/doap.ttl +++ b/doap.ttl @@ -1,12 +1,12 @@ @prefix rdf: . @prefix doap: . @prefix foaf: . -@prefix : . +@prefix : . :p a doap:Project; - doap:name "Readable"; + doap:name "SimplyRead"; doap:shortdesc "Makes webpages more readable"; - doap:homepage ; + doap:homepage ; doap:repository :repo; doap:programming-language "ECMAScript"; doap:license ; @@ -18,15 +18,15 @@ foaf:homepage . :repo a doap:GitRepository; - doap:location . + doap:location . :v0.1 a doap:Version; doap:revision "0.1"; doap:created "2010-10-23"; - doap:file-release . + doap:file-release . :v0.2 a doap:Version; doap:revision "0.2"; doap:created "2010-11-04"; - doap:file-release , - . + doap:file-release , + . diff --git a/gecko/chrome.manifest b/gecko/chrome.manifest index fa8891b..837e8e8 100644 --- a/gecko/chrome.manifest +++ b/gecko/chrome.manifest @@ -1,2 +1,2 @@ -content readable chrome/content/ -overlay chrome://browser/content/browser.xul chrome://readable/content/readable.xul +content simplyread chrome/content/ +overlay chrome://browser/content/browser.xul chrome://simplyread/content/simplyread.xul diff --git a/gecko/chrome/content/readable.xul b/gecko/chrome/content/readable.xul deleted file mode 100644 index 75ab8fd..0000000 --- a/gecko/chrome/content/readable.xul +++ /dev/null @@ -1,10 +0,0 @@ - - -