Permalink
Browse files

more info to the readme

  • Loading branch information...
1 parent 06efbc4 commit f24c2a10adb25fb16283c74287d48728a8285271 @mfilej committed Feb 12, 2010
Showing with 21 additions and 7 deletions.
  1. +21 −7 README.markdown
View
28 README.markdown
@@ -1,6 +1,6 @@
# Twitter Haiku
-Twitter Haiku is a small script that produces a pdf with haikus from [Twitter][twitter]. It pulls 50 most recent tweets marked with the hashtag #haiku, discards the ones that don't look like haikus and prettifies the rest. It also discards duplicates (usually retweets). Tweet manipulation is handled by ruby while luatex and context take care of the typesetting and pdf generation.
+Twitter Haiku is a set of small scripts that produce a pdf with haikus from [Twitter][twitter]. It pulls 50 recent tweets marked with the hashtag #haiku, discards the ones that don't look like haikus and prettifies the rest. It also discards duplicates (usually retweets). Tweet manipulation is handled by ruby while LuaTeX and ConTeXt take care of the typesetting and pdf generation.
## Running the scripts
@@ -11,17 +11,31 @@ The following tasks are available:
rake build # Build the pdf file
rake clean # Remove generated pdf and temporary files
rake fetch # Fetch a fresh twitter feed
- rake prepare # Rewrites the twitter feed by normalizing tweets
+ rake prepare # Rewrite the twitter feed by normalizing tweets
rake test # Run tests
To get a fresh pdf file from scratch:
- rake prepare build
+ $ rake
-If ruby and rake are not available it is still possible to generate the pdf file manually by running:
+If ruby and rake are not available it is still possible to generate the pdf file manually:
- context haiku.tex
+ $ context haiku.tex
+## Installing LuaTeX
+
+Depending on the availability or lack of packages for your platform of choice it may not be the easiest task. [Contextgarden][luatex] might be a good start.
+
+## About the project
+
+Written by [Miha Filej][mfilej] for the course Typographic programming taught by [Petr Sojka][sojka] at [FI-MUNI][fi].
+
+
+ [rake]: http://rake.rubyforge.org/
+ [twitter]: http://twitter.com/
+ [mfilej]: http://twitter.com/mfilej
+ [luatex]: http://minimals.contextgarden.net/
+ [sojka]: http://www.fi.muni.cz/usr/sojka/
+ [fi]: http://fi.muni.cz/
+ [typo]: https://is.muni.cz/auth/predmety/predmet.pl?lang=en;id=519265;zpet=..%2Fpredmety%2Fkatalog.pl%3Ffakulta%3D1433%3Blang%3Den%3Bhledret%3DPV126%3Bhledv%3Dnaz%3Bhledv%3Dkod%3Bfak%3D1433%3Buhledat%3D1;zpet_text=Back%20to%20course%20search
- [rake]: http://rake.rubyforge.org/
- [twitter]: http://twitter.com/

0 comments on commit f24c2a1

Please sign in to comment.