Add basic README

[Hoolean]

No description provided.

[vv-monsalve]

Hello @Hoolean,

Is the tool ready to be used with any font? I would like to use it to help determine the VM for Arabic and Devanagari fonts.

It would be really helpful to have installation and usage instructions in the Readme.

Thanks!

[Hoolean]

@vv-monsalve Hi Viviana! Not yet unfortunately, we only have the skeleton here right now, but we're scheduled to pick up development again in the next couple of weeks :)

[vv-monsalve]

Awesome! :-)

[davelab6]

@Hoolean I'd like to ask priorizing this as now the internal GF eng team needs it :) cc @chrissimpkins

[belluzj]

Hello @davelab6 , which part of the fontheight tool is needed in priority? We have plans for:

• a CLI tool to report the vertical min/max from the command line
• a FontBakery check that the Win metrics are large enough to encompass the vertical min/max
• an HTML report with SVG pictures of shaped words that hit the lowest and highest points

@Hoolean FYI

[RickyDaMa]

I'll make sure the README is written once the tool is in a usable state - currently it's not usable by anyone unless they're also going to be hacking on the Rust code.

Of what's mentioned in Jany's message, we're currently prioritising the FontBakery check. There is a commandline tool version in-repo right now, though that's more for ease of testing as it doesn't produce useful information for end users currently

[davelab6]

I'm sorry I meant just the readme, I was sharing the tool internally and people asked "what is it" lol

Having a mission/vision statement in the readme about what it will be in future is ideal if it's not yet running at all

[davelab6]

Cli would be great to get running in a useful way before a check wrapper

[belluzj]

Makes sense, thanks for the clarifications!

[RickyDaMa]

Added a basic explainer of why the tool exists and what it does (will do). Let me know if there's anything else you'd like me to add!