README.md in cheapredwine-0.2.0 vs README.md in cheapredwine-0.3.1
- old
+ new
@@ -16,54 +16,44 @@
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](https://github.com/mcolyer/fonttools)
## Usage
#### Getting a font object from a simple ttf or otf file:
- font = CheapRedWine.font(font_file)
+ font = CheapRedWine.new font_file
font.name # => "Font Name"
+ font.family # => "Font Family"
+ font.style # => "Bold Italic"
font.features # => ["liga", "onum", "dlig", … "salt"]
#### Generating images with text for the font:
- image = CheapRedWine.image(font, "some text", options)
+ image = font.image "some text", options
+ # ... do something with image ...
+ image.close
-**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.
-
+**Caveat:** `image` is an IO object that can then be use to write to disk. You are responsible to close that object.
+
##### Options
options = {
margin: 5, # margin around the text
size: 40, # size of the text eq to px
color: red, # the text color
features: [liga, salt] # list of otf features to be applied
}
-##### Configuration
-
-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).
+1. Replace hb-view by something more appropriate (C Extension).