README.md in cheapredwine-0.0.2 vs README.md in cheapredwine-0.1.0
- old
+ new
@@ -16,11 +16,11 @@
It assumes the following is installed and in the case where it applies, accessible from the $PATH env variable.
* [cairo](http://www.cairographics.org/releases/)
* [harfbuzz](http://www.freedesktop.org/software/harfbuzz/release/)
-* [ttx](git@github.com:mcolyer/fonttools.git)
+* [ttx](https://github.com/mcolyer/fonttools)
## Usage
#### Getting a font object from a simple ttf or otf file:
@@ -30,12 +30,11 @@
#### Generating images with text for the font:
image = CheapRedWine.image(font, "some text", options)
-`image` is an IO object that can then be use to write to disk
-
+**Caveat: ** `image` is an IO object that can then be use to write to disk. `font` is any object that responds to `#features` and produces a list `["onum", "liga"]` as well as provide a font file object through `#file`. `file` need only know of it's full path to work properly.
##### Options
options = {
margin: 5, # margin around the text
@@ -49,13 +48,22 @@
CheapRedWine needs to know where to put ttx files
CheapRedWine::TTX.configure do |config|
config.output_folder = '/path/to/folder'
end
+
+You can also change the output_folder dynamically through
+
+ CheapRedWine.ttx_output_folder = "path/to/folder"
## Contributing
1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request
+
+## TODO
+
+1. Create a new utility using fontTools to have more granularity regarding ttx file outputs
+2. Replace hb-view by something more appropriate (C Extension).