robotools / fontParts

The replacement for RoboFab
MIT License
129 stars 44 forks source link

fontParts 101 #262

Open roberto-arista opened 6 years ago

roberto-arista commented 6 years ago

Dear all, during Robothon I approached @benkiel willing to help a little bit with tests. But, as @typemytype told me yesterday at typolabs, they are almost ready. I was not quick enough ¯_(ツ)_/¯ Also, I tried to dive a little bit into the tests, but with my degree of experience with them (and OOP), I do not think I could be very helpful at this stage.

But, I still want to contribute. My proposal is to compile a FontParts 101 cookbook. During the years, especially while I was doing my first steps with Python, I found the Python Cookbook by David Beazley very useful. I would have definitely used also a Robofab cookbook, so maybe now is the time to make one for fontParts.

What do you think about this? Should I move forward?

In case, I would move as follow:

ps @typemytype told me “hey, snippets are cool, but they have to work”. So, they should be tested similarly to what happens with Drawbot docs snippets. Any help with setting this, would be nice. I am a fast learner! : )

typesupply commented 6 years ago

This is a great idea! (It might be good to replace #217 with this.)

andyclymer commented 6 years ago

Nice! I'd love to contribute.

benkiel commented 6 years ago

Agree, this is a great idea (even if @typemytype is a bit optimistic about the tests, there is still plenty to do!), let's do it.

Your plan makes sense, I'd start building it out in the documentation under the https://github.com/robofab-developers/fontParts/tree/master/documentation/source/gettingstarted section.

I do think there are things you can pull from the older RoboFab documentation, and it is worth talking with @campbellgraphics about this, as he volunteered to help port the documentation, but I don't know the current state of that.

All that said, yes, do it! (and thank you!)

campbellgraphics commented 6 years ago

cool idea. I'm further behind than I'd thought, so I don't have any new/updated documentation built yet. I'll add or contribute wherever makes sense

roberto-arista commented 6 years ago

👌

gferreira commented 6 years ago

see also: Simple scripts

roberto-arista commented 6 years ago

It took some time, but finally I managed to compile the following list of routines:

Bookkeeping

Transform a glyph

Automatic building of glyphs

Working with contours

Testing

Transfer data across fonts (and adjust it if needed)

What do you think? Anything else you would like to see in that list? Did I miss any big category of problems? Some routines are similarly covered in the simple scripts section of the robofont documentation previously posted by @gferreira. Should we avoid duplication?

benkiel commented 6 years ago

I would take what makes sense from the RoboFont documentation, but cast it in a FontParts only way: it's ok if there is duplication, FontParts isn't RoboFont, and will hopefully live as a common scripting layer the way RoboFab became.