Skip to content

Commit

Permalink
better README!
Browse files Browse the repository at this point in the history
  • Loading branch information
madrobby committed Sep 28, 2009
1 parent ffc37c2 commit 3dce5e8
Show file tree
Hide file tree
Showing 2 changed files with 44 additions and 25 deletions.
25 changes: 0 additions & 25 deletions README

This file was deleted.

44 changes: 44 additions & 0 deletions README.rdoc
@@ -0,0 +1,44 @@
= textorize: for a more beautiful web

textorize produces beautifully subpixel antialiased text graphics on OS X, through a Rubycocoa Ruby script.

Output format is always PNG.

= Learn more

View the presentation on why this is awesome and how it compares to other "web typography" solutions and techniques:
http://www.slideshare.net/madrobby/textorize

= Install

Install the gem and binary by doing:

$ gem sources -a http://gems.github.com
$ sudo gem install madrobby-textorize

This will install the textorize Ruby Gem, and the +textorize+ command
line tool.

= Usage (command line tool)

textorize [options] string
-f, --font=[FONT] Font name
-s, --size=[SIZE] Font size in point
-l, --lineheight=[HEIGHT] Line height in point
-o, --output=[FILENAME] Specify filename for saving
-b, --obliqueness=[ANGLE] Slant angle (radians)
-c, --color=[COLOR] Render text in specific color
--background=[COLOR] Render background in specific color
-h, --help Display this message and exit

= Examples

textorize -f"Gotham" -s200 Hello

textorize -fLucida\ Grande -s150 --color=0.5,1,0.5 --background=0,0,0.5 foo\ bar

= It's alpha!

This software is alpha-quality and has some bugs and known issues. Please contribute!

textorize is released under the MIT license.

0 comments on commit 3dce5e8

Please sign in to comment.