Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

more info to the readme

  • Loading branch information...
commit f24c2a10adb25fb16283c74287d48728a8285271 1 parent 06efbc4
Miha Filej authored

Showing 1 changed file with 21 additions and 7 deletions. Show diff stats Hide diff stats

  1. +21 7 README.markdown
28 README.markdown
Source Rendered
... ... @@ -1,6 +1,6 @@
1 1 # Twitter Haiku
2 2
3   -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.
  3 +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.
4 4
5 5 ## Running the scripts
6 6
@@ -11,17 +11,31 @@ The following tasks are available:
11 11 rake build # Build the pdf file
12 12 rake clean # Remove generated pdf and temporary files
13 13 rake fetch # Fetch a fresh twitter feed
14   - rake prepare # Rewrites the twitter feed by normalizing tweets
  14 + rake prepare # Rewrite the twitter feed by normalizing tweets
15 15 rake test # Run tests
16 16
17 17 To get a fresh pdf file from scratch:
18 18
19   - rake prepare build
  19 + $ rake
20 20
21   -If ruby and rake are not available it is still possible to generate the pdf file manually by running:
  21 +If ruby and rake are not available it is still possible to generate the pdf file manually:
22 22
23   - context haiku.tex
  23 + $ context haiku.tex
24 24
  25 +## Installing LuaTeX
  26 +
  27 +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.
  28 +
  29 +## About the project
  30 +
  31 +Written by [Miha Filej][mfilej] for the course Typographic programming taught by [Petr Sojka][sojka] at [FI-MUNI][fi].
  32 +
  33 +
  34 + [rake]: http://rake.rubyforge.org/
  35 + [twitter]: http://twitter.com/
  36 + [mfilej]: http://twitter.com/mfilej
  37 + [luatex]: http://minimals.contextgarden.net/
  38 + [sojka]: http://www.fi.muni.cz/usr/sojka/
  39 + [fi]: http://fi.muni.cz/
  40 + [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
25 41
26   - [rake]: http://rake.rubyforge.org/
27   - [twitter]: http://twitter.com/

0 comments on commit f24c2a1

Please sign in to comment.
Something went wrong with that request. Please try again.