Skip to content

Commit

Permalink
clean up markdown files and comments for next steps
Browse files Browse the repository at this point in the history
  • Loading branch information
Yifei Zhang committed Apr 5, 2013
1 parent 3f8ccda commit 822f61d
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 16 deletions.
13 changes: 8 additions & 5 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
## 1.0.0-RC1 (4/1/2013)
## 1.0.0-RC1 (4/4/2013)

* Refactored gem internals to reflect saner usage of Thor
* Refactored tests
* Improved preview html to show glyphs at various sizes
* Added support for fontcustom.yml config file ([#49](https://github.com/FontCustom/fontcustom/issues/49))
* Added support for .fontcustom-data file ([#55](https://github.com/FontCustom/fontcustom/pull/55))
* Added support for SCSS template ([#48](https://github.com/FontCustom/fontcustom/issues/48))
* Added support for custom templates ([#39](https://github.com/FontCustom/fontcustom/pull/39))
* Added support for custom templates ([#39](https://github.com/FontCustom/fontcustom/pull/39), [#48](https://github.com/FontCustom/fontcustom/issues/48))
* Added support for custom CSS selector namespaces ([#32](https://github.com/FontCustom/fontcustom/issues/32))
* Added support for --verbose=false ([#54](https://github.com/FontCustom/fontcustom/pull/54))
* Improved ascent/decent heights ([#33](https://github.com/FontCustom/fontcustom/issues/33))
* Fixed bug where watcher could fall into an infinite loop
* Added error messages for faulty input
* Refactored gem internals to reflect saner usage of Thor
* Refactored tests

## 0.1.4 (2/19/2013)

Expand Down
23 changes: 15 additions & 8 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,18 @@
# FontCustom Contributing Checklist
# FontCustom Contributing Guidelines

First, thanks for your interest in making FontCustom better! This project was born out of an over-heard conversation between two devs in a coffee shop — it's come a long ways thanks to the support of kind folks like you.
Thanks for helping make FontCustom better! This project was born out of an over-heard conversation between two devs in a coffee shop — it's come a long ways thanks to the support of folks like you.

## A short list to help you get started:
## Conventions

* Check out [issues]() for ideas. Is someone else working on something similar?
* Fork the repo and work out of a named topic branch, a la `git checkout -b my_sweet_contribution`. Please don't work directly off `master`.
* Run tests with `guard`.
* Add/improve tests for your contributions.
* Submit a pull request!
We try to follow the [Github ruby styleguide](https://github.com/styleguide/ruby) as much as possible.

If you catch a typo or a particularly unsightly piece of code — please _do_ let us know. No such thing as too small of an improvement.

## Process

* Visit [issues](https://github.com/FontCustom/fontcustom/issues) for ideas.
* Fork the repo if you haven't done so already.
* Create a topic branch. `git checkout -b my_sweet_feature`
* Add tests. Run tests with `rake`.
* Develop your feature.
* Once all tests are passing, submit a pull request!
6 changes: 3 additions & 3 deletions lib/fontcustom/generator/font.rb
Original file line number Diff line number Diff line change
Expand Up @@ -64,10 +64,10 @@ def generate
hash = opts[:file_hash] ? "" : " --nohash"
cmd = "fontforge -script #{Fontcustom::Util.gem_lib_path}/scripts/generate.py #{opts[:input]} #{opts[:output] + name + hash}"

# TODO test out whether this is even necessary
cmd << " 2>&1" unless opts[:debug]

output = `#{cmd}`
if not opts[:debug]
unless opts[:debug]
output = output.split(/\n/)
output.slice!(0..2)
end
Expand All @@ -76,7 +76,7 @@ def generate
raise Fontcustom::Error, "Compilation failed unexpectedly. Check your options and try again with --debug get more details."
end

# TODO move this into generate.py
# TODO use generate.py to add fonts, glyphs and file_name directly to .fontcustom-data
def collect_data
@data[:glyphs] = Dir[File.join(opts[:input], "*.{svg,eps}")]
@data[:glyphs].map! { |vector| File.basename(vector)[0..-5].gsub(/\W/, "-").downcase }
Expand Down

0 comments on commit 822f61d

Please sign in to comment.