Permalink
Browse files

Add contributing and readme files

  • Loading branch information...
jamesgk committed Nov 17, 2015
1 parent 89cd9b0 commit ff8f62e92f06cef4158fb9be327487d45ba047e3
Showing with 55 additions and 0 deletions.
  1. +28 −0 CONTRIBUTING.md
  2. +27 −0 README.md
@@ -0,0 +1,28 @@
Want to contribute? Great! First, read this page (including the small print
at the end).
### Before you contribute
Before we can use your code, you must sign the
[Google Individual Contributor License
Agreement](https://cla.developers.google.com/about/google-individual)
(CLA), which you can do online. The CLA is necessary mainly because you own the
copyright to your changes, even after your contribution becomes part of our
codebase, so we need your permission to use and distribute your code. We also
need to be sure of various other things—for instance that you'll tell us if you
know that your code infringes on other people's patents. You don't have to sign
the CLA until after you've submitted your code for review and a member has
approved it, but you must do it before we can put your code into our codebase.
Before you start working on a larger contribution, you should get in touch with
us first through the issue tracker with your idea so that we can help out and
possibly guide you. Coordinating up front makes it much easier to avoid
frustration later on.
### Code reviews
All submissions, including submissions by project members, require review. We
use Github pull requests for this purpose.
### The small print
Contributions made by corporations are covered by a different agreement than
the one above, the
[Software Grant and Corporate Contributor License
Agreement](https://cla.developers.google.com/about/google-corporate).
@@ -0,0 +1,27 @@
# fontmake
This library provides a wrapper for several other Python libraries which
together compile fonts from various sources (.glyphs, .ufo) into binaries (.otf,
.ttf).
### Install
```bash
sudo python setup.py install
```
### Run
After installation, fontmake can be run end-to-end as a module:
```bash
# outputs master binaries
python -m fontmake MyFont.glyphs
```
Use `-h` to see a list of runtime options. `-i` will output instance binaries,
`-c` will ensure the output is interpolation compatible (for both masters and
instances).
You can also use fontmake to run intermediate steps in the build process, via
methods of the `fontmake.font_project.FontProject` class.

0 comments on commit ff8f62e

Please sign in to comment.