X-Git-Url: https://iankelling.org/git/?p=spray;a=blobdiff_plain;f=Readme.org;h=f47fab353a5d8a03ac820ff554a6975211bcafb0;hp=9485f1b8a0fc0b75528176e12f0b3652a8e17f58;hb=c87b4acf63205050e4249864f81a17d78b805c93;hpb=091c1d22fdca14e2cb7e3170c5f8ec191d996280 diff --git a/Readme.org b/Readme.org index 9485f1b..f47fab3 100644 --- a/Readme.org +++ b/Readme.org @@ -11,47 +11,6 @@ The algorithm is inspired from [[https://github.com/Miserlou/OpenSpritz][OpenSpr The story continues at [[https://www.gnu.org/philosophy/right-to-read.html][gnu.org]] - -** Deficiencies in similar projects which spray.el solves: - -Mostly as of June 28, 2014. - -For all other projects: -- It is very difficult to save your place and come back later. Emacs has lots of built in features like bookmarks or just making a note which make this easy. -- No keybinds. This is especially useful for common, quickly used functionality like pause and back up. - -Specific projects: -- https://github.com/jbmartinez/speed-readerff firefox extension. -- https://github.com/cameron/squirt javascript bookmarklet. -- https://github.com/Miserlou/OpenSpritz javascript bookmarklet. - - Very difficult selecting where to start / what exactly to read. - - Very difficult to figure out where you are within a document. - - -- https://github.com/chaimpeck/spray website you paste text into. - - Very difficult to figure out where you are within a document. - -- https://github.com/xypiie/spread0r Perl program. - - No apparent way to resize text. - - Very difficult to figure out where you are within a document. - - -- https://github.com/the-happy-hippo/sprits-it website or bookmarklet. Looks most promising of the web based projects. - - Very difficult selecting where to start / what exactly to read. - - Somewhat difficult to figure out where you are in a document. - - -Programs that I, Ian Kelling, didn't try, and why. They also probably have a lot of the problems listed above. -- https://github.com/pasky/speedread No simple way to resize text from default of too small. -- https://github.com/ds300/jetzt Chrome plugin: Chrome is proprietary, and its open source version is unfriendly to linux distros so they don't package it, and it's readme does not list any benefit to this program over others. -- https://github.com/Fr4ncis/openspritz-ios ios program. I don't have an ios device, and this does not appear to have any compelling features. -- https://github.com/OnlyInAmerica/OpenSpritz-Android android program. If I knew how to quickly move reading material to my phone, I would try this out. But, it's readme shows that the program is pretty sparse and would have some of the same problems as listed above, so not worth it. - - -Downsides compared to similar projects: -- The emacs learning curve. -- Would be hard to get running on a phone. - ** Installation Put spray.el into a "load-path"ed directory, and load it in your init @@ -100,6 +59,51 @@ You may customize spray by modifying following items: - [Face] spray-base-face - [Face] spray-accent-face + +** Similar emacs package: speedread + +Available in marmalade or +[[https://github.com/vapniks/speedread/blob/master/speedread.el][github]] +It has several nice features and does not align on an accent character. Eventually I'd like to merge the two packages. + +** Deficiencies in similar projects which spray.el solves: + +Mostly as of June 28, 2014. + +For all other projects: +- It is very difficult to save your place and come back later. Emacs has lots of built in features like bookmarks or just making a note which make this easy. +- No keybinds. This is especially useful for common, quickly used functionality like pause and back up. + +Specific projects: +- [[https://github.com/jbmartinez/speed-readerff][speed-readerff]] firefox extension. +- [[https://github.com/cameron/squirt][squirt]] javascript bookmarklet. +- [[https://github.com/Miserlou/OpenSpritz][OpenSpritz]] javascript bookmarklet. + - Very difficult selecting where to start / what exactly to read. + - Very difficult to figure out where you are within a document. + +- [[https://github.com/chaimpeck/spray][spray]] website you paste text into. + - Very difficult to figure out where you are within a document. + +- [[https://github.com/xypiie/spread0r][spread0r]] Perl program. + - No apparent way to resize text. + - Very difficult to figure out where you are within a document. + +- [[https://github.com/the-happy-hippo/sprits-it][sprits-it]] website or bookmarklet. Looks most promising of the web based projects. + - Very difficult selecting where to start / what exactly to read. + - Somewhat difficult to figure out where you are in a document. + +Programs that I, Ian Kelling, didn't try, and why. They also probably have a lot of the problems listed above. +- https://github.com/pasky/speedread No simple way to resize text from default of too small. +- https://github.com/ds300/jetzt Chrome plugin: Chrome is proprietary, and its open source version is unfriendly to linux distros so they don't package it, and it's readme does not list any benefit to this program over others. +- https://github.com/Fr4ncis/openspritz-ios ios program. I don't have an ios device, and this does not appear to have any compelling features. +- https://github.com/OnlyInAmerica/OpenSpritz-Android android program. If I knew how to quickly move reading material to my phone, I would try this out. But, it's readme shows that the program is pretty sparse and would have some of the same problems as listed above, so not worth it. + + +Downsides compared to similar projects: +- The emacs learning curve. +- Would be hard to get running on a phone. + + ** Algorithm details *** Main algorithm code location