Readme + building instructions

[vv-monsalve]

Please update the README.md file with the following:

• Detailed info for the project. It should include at least one image.
• Building instructions to produce all the fonts including the country models

[vv-monsalve]

Lets keep this open until we migrate to Builder2

[vv-monsalve]

Hi @casasin

After having a 1:1 result between the builder2 and the lang-build fonts, today, we gave the green light to migrate to builder2. The following steps are needed to complete the migration:

• Stop pushing changes to the lang-build branch. The last commit there should remain the bba3221 Update sources.
• Starting today, please use the builder2 branch for further pushes. Any new modification to the source files should happen there.
• Use the make build command to build the fonts locally.
  Note: You don't need to make your own venv because the Makefile creates one for you - but if the build doesn't work, you need to delete the venv so it can make a new one.
• Use the rebuild-one.sh script when you need to build only one font (e.g., for testing purposes while developing). This would require doing it under a venv.

Please report to us about any questions or issues you might have during the transition time.

cc @simoncozens, @chrissimpkins, @davelab6

[simoncozens]

Just to confirm, bba3221 Update sources is part of the builder2 branch.

[casasin]

Got it. Thanks and so cool @simoncozens !
Some questions:

• Should I add "build.stamp", "fonts/", "sources/.ninja_log" and "sources/build.ninja" to .gitignore ? (as these are changed with every build locally).

• When we have updates: Which are the files that are enough to be updated? At a first sight these would be:

  • /sources/Playwrite_MM.glyphspackage
  • /sources/data/models-all.csv
  • /sources/features/Playwrite.fea
  • /sources/features/Playwrite-models.fea
  • /sources/fea-models/

Is this right or am I missing some or updating something not needed?
(I'll wait for confirmation before pushing our latest updates)

Many thanks for your help.

[simoncozens]

Should I add "build.stamp", "fonts/", "sources/.ninja_log" and "sources/build.ninja" to .gitignore ? (as these are changed with every build locally).

You may want to check in the built fonts for convenience, but the others should go in .gitignore, yes.

When we have updates: Which are the files that are enough to be updated?

sources/fea-models and /sources/features/Playwrite-models.fea are no longer used. Everything is driven from the models-all.csv file and the main feature code. So just the glyphspackage file, the main feature file and models-all.csv.

When models-all is changed, the configuration file needs to change as well. But I will add a commit automating that in the makefile. (I forgot that I already did this!)

[vv-monsalve]

Bringing here the comment from José in #52

There should be some rewriting of the Create or edit handwriting models section, also we need to see whether the doc mentioned in that section is still valid.

[casasin]

I'm working on it, I'll update it right today.

[casasin]

@vv-monsalve @josescaglione : README.md has been updated. Please have a look and close the issue if all is ok now.

[vv-monsalve]

I've created a PR that introduces a CHANGELOG.md file.

Following that, we should include a "Releasing" section in the Readme with instructions on the required steps to create a new one.

cc @simoncozens since we might review the current release process.