Create a descriptive README.md

[RosaWagner]

Hi @kosmynkab, can you take care of this issue while I am working on building the font? I won't be able to onboard it if the repo is not public or if the readme is not complete.

[kosmynkab]

Hi @RosaWagner shall I just make the repo's public? I looked at some of the Readme.md at some of the google fonts - I will finish writing and upload for both tomorrow so we can close this as well.

[RosaWagner]

Yes you can make it public ;) cool !

[RosaWagner]

These are instructions to add to the README.md

Workflow

When you push modifications in the sources directory on the main branch, github will perfom some actions on these changes: It builds the fonts for you and check with Fontbakery if the builds pass Google Fonts Quality Assurance Checks. You can find the result of this action in the Actions tab. You will have to click on the last action (which carries the name of your commit) and there you will find a package to download (Brygada1918_Fonts) in the "Artifacts" section.

If you are satisfied with the result, you can push the fonts into the repository, and make a release. :)

[kosmynkab]

@RosaWagner Thx! I made it public and edited the readme.md - I couldn't see your instructions - but you can see what I wrote out in the repo (sorry - my github mastery is not advanced enough for me to change the typographic structure :| – I'll look into it and edit tomorrow and do the same for Bona!

(also not sure what does the instructions that you posted in that comment mean - do I have to make further changes at the moment to the typeface source files?)

[RosaWagner]

Haha, ok let's have a call so I explain. I am available today :)

[kosmynkab]

Hi - so sorry - I had an intense end of the week. Would you have a moment today/tomorrow?

[RosaWagner]

Later today, okay. Any time you want.

[kosmynkab]

perfect - sorry for the late looking - can we have a chat within the next hour or so? whatever works best - google meet/zoom/whereby :)

[kosmynkab]

I'll just put a provisionary google cal slot - the only time I can't do is thursday 10-13 London time other than that - feel free to get back to me with better time :)

[RosaWagner]

Hi, sorry I stopped working earlier today. Thursday morning then, 11 Berlin time (10 for you I think)

[RosaWagner]

But the invite you sent says Wednesday

[kosmynkab]

I meant that i am not able to have a meeting 10-13 on thursday - I'm giving a workshop/presentation at Reading (online). So anything around that works :).

[RosaWagner]

Ah sorry, i still need to learn how to read. Tomorrow then, see ya

[kosmynkab]

Hi Rosalie!

I updated the readme file - can you take a look and close the issue if it's ok now?

[RosaWagner]

It good :)

• [ ] Can you add an image?
• [x] Can you add these instructions for building the fonts?

Workflow

When you push modifications in the sources directory on the main branch, github will perform some actions on these changes: It builds the fonts for you and check with Fontbakery if the builds pass Google Fonts Quality Assurance Checks. If you want to download the package containg the fonts and the report, got to the Action tab, click on the last action (which carries the name of your last commit) and there you will find a package to download (Brygada1918_Fonts) in the "Artifacts" section.

If you want to build the font locally. First, install gftools in a virtual environment (anywhere but preferably in your local repo, and not in icloud):

$ python3 -m venv env
$ source env/bin/activate
$ pip install gftools

Then, you can build the fonts with this command:

$ cd path/to/sources
$ gftools builder config.yaml

Make sure you always activate the virtual env before hand each time you want to build ($ source env/bin/activate)

[kosmynkab]

can we use the same image as the one for twitter?

[RosaWagner]

If it fits in size etc yes