Merge pull request #17 from vv-monsalve/master

Sample image for Readme file

Author: mightybart

CONTRIBUTORS.txt

@@ -10,4 +10,5 @@
 # Name <email address>
 
 Florian Karsten <fonts@floriankarsten.com>
-Květoslav Bartoš <kvetoslav.bartos@gmail.com>
+Květoslav Bartoš <kvetoslav.bartos@gmail.com>
+Viviana Monsalve <viviana.monsalve.a@gmail.com>

Documentation/image1.png

@@ -0,0 +1,135 @@
+# This script is meant to be run from the root level
+# of your font's git repository. For example, from a Unix terminal:
+# $ git clone my-font
+# $ cd my-font
+# $ python3 documentation/image1.py --output documentation/image1.png
+
+# Import moduels from external python packages: https://pypi.org/
+from drawbot_skia.drawbot import *
+from fontTools.ttLib import TTFont
+from fontTools.misc.fixedTools import floatToFixedToStr
+
+# Import moduels from the Python Standard Library: https://docs.python.org/3/library/
+import subprocess
+import sys
+import argparse
+
+# Constants, these are the main "settings" for the image
+WIDTH, HEIGHT, MARGIN, FRAMES = 4050, 1536, 128, 1
+FONT_PATH = "../fonts/ttf/MontaguSlab144pt-Bold.ttf"
+FONT_LICENSE = "OFL v1.1"
+AUXILIARY_FONT = "Helvetica"
+AUXILIARY_FONT_SIZE = 24
+BIG_TEXT = "Montagu Slab"
+BIG_TEXT_FONT_SIZE = 512
+BIG_TEXT_SIDE_MARGIN = MARGIN * 1.5
+BIG_TEXT_BOTTOM_MARGIN = MARGIN * 4
+GRID_VIEW = False # Change this to "True" for a grid overlay
+
+# Handel the "--output" flag
+# For example: $ python3 documentation/image1.py --output documentation/image1.png
+parser = argparse.ArgumentParser()
+parser.add_argument("--output", metavar="PNG", help="where to write the PNG file")
+args = parser.parse_args()
+
+# Load the font with the parts of fonttools that are imported with the line:
+# from fontTools.ttLib import TTFont
+# Docs Link: https://fonttools.readthedocs.io/en/latest/ttLib/ttFont.html
+ttFont = TTFont(FONT_PATH)
+
+# Constants that are worked out dynamically
+MY_URL = subprocess.check_output("git remote get-url origin", shell=True).decode()
+MY_HASH = subprocess.check_output("git rev-parse --short HEAD", shell=True).decode()
+FONT_NAME = ttFont["name"].getDebugName(4)
+FONT_VERSION = "v%s" % floatToFixedToStr(ttFont["head"].fontRevision, 16)
+
+
+# Draws a grid
+def grid():
+    stroke(1, 0, 0, 0.75)
+    strokeWidth(2)
+    STEP_X, STEP_Y = 0, 0
+    INCREMENT_X, INCREMENT_Y = MARGIN / 2, MARGIN / 2
+    rect(MARGIN, MARGIN, WIDTH - (MARGIN * 2), HEIGHT - (MARGIN * 2))
+    for x in range(29):
+        polygon((MARGIN + STEP_X, MARGIN), (MARGIN + STEP_X, HEIGHT - MARGIN))
+        STEP_X += INCREMENT_X
+    for y in range(29):
+        polygon((MARGIN, MARGIN + STEP_Y), (WIDTH - MARGIN, MARGIN + STEP_Y))
+        STEP_Y += INCREMENT_Y
+    polygon((WIDTH / 2, 0), (WIDTH / 2, HEIGHT))
+    polygon((0, HEIGHT / 2), (WIDTH, HEIGHT / 2))
+
+
+# Remap input range to VF axis range
+# This is useful for animation
+# (E.g. sinewave(-1,1) to wght(100,900))
+def remap(value, inputMin, inputMax, outputMin, outputMax):
+    inputSpan = inputMax - inputMin  # FIND INPUT RANGE SPAN
+    outputSpan = outputMax - outputMin  # FIND OUTPUT RANGE SPAN
+    valueScaled = float(value - inputMin) / float(inputSpan)
+    return outputMin + (valueScaled * outputSpan)
+
+
+# Draw the page/frame and a grid if "GRID_VIEW" is set to "True"
+def draw_background():
+    newPage(WIDTH, HEIGHT)
+    fill(0)
+    rect(-2, -2, WIDTH + 2, HEIGHT + 2)
+    if GRID_VIEW:
+        grid()
+    else:
+        pass
+
+
+# Draw main text
+def draw_main_text():
+    fill(1)
+    stroke(None)
+    font(FONT_PATH)
+    fontSize(BIG_TEXT_FONT_SIZE)
+    # Adjust this line to center main text manually.
+    # TODO: This should be done automatically when drawbot-skia
+    # has support for textBox() and FormattedString
+    #text(BIG_TEXT, ((WIDTH / 2) - MARGIN * 4.75, (HEIGHT / 2) - MARGIN * 2.5))
+    text(BIG_TEXT, (BIG_TEXT_SIDE_MARGIN, BIG_TEXT_BOTTOM_MARGIN))
+
+
+# Divider lines
+def draw_divider_lines():
+    stroke(1)
+    strokeWidth(4)
+    lineCap("round")
+    line((MARGIN, HEIGHT - MARGIN), (WIDTH - MARGIN, HEIGHT - MARGIN))
+    line((MARGIN, MARGIN + (MARGIN / 2)), (WIDTH - MARGIN, MARGIN + (MARGIN / 2)))
+    stroke(None)
+
+
+# Draw text describing the font and it's git status & repo URL
+def draw_auxiliary_text():
+    # Setup
+    font(AUXILIARY_FONT)
+    fontSize(AUXILIARY_FONT_SIZE)
+    POS_TOP_LEFT = (MARGIN, HEIGHT - MARGIN * 1.5)
+    POS_TOP_RIGHT = (WIDTH - MARGIN, HEIGHT - MARGIN * 1.5)
+    POS_BOTTOM_LEFT = (MARGIN, MARGIN)
+    POS_BOTTOM_RIGHT = (WIDTH - MARGIN * 0.95, MARGIN)
+    URL_AND_HASH = MY_URL + "at commit " + MY_HASH
+    URL_AND_HASH = URL_AND_HASH.replace("\n", " ")
+    # Draw Text
+    text(FONT_NAME, POS_TOP_LEFT, align="left")
+    text(FONT_VERSION, POS_TOP_RIGHT, align="right")
+    text(URL_AND_HASH, POS_BOTTOM_LEFT, align="left")
+    text(FONT_LICENSE, POS_BOTTOM_RIGHT, align="right")
+
+
+# Build and save the image
+if __name__ == "__main__":
+    draw_background()
+    draw_main_text()
+    draw_divider_lines()
+    draw_auxiliary_text()
+    # Save output, using the "--output" flag location
+    saveImage(args.output)
+    # Print done in the terminal
+    print("DrawBot: Done")

Documentation/image1.py

@@ -4,6 +4,8 @@ Montagu Slab is a slab-serif display typeface designed by Florian Karsten. The t
 
 The optical size axis, which controls x-height, spacing, contrast and aperture, provides a wide range of variation – from low contrast and higher x-height version suitable for longer text, to a tight and high contrast display variant with prominent upturned tails.
 
+![Sample Image](Documentation/image1.png)
+
 ## Pre-building the Fonts
 
 If you want to make a contribution and generate new fonts, before building them, it is necessary to decompose all smart components inside the Glyphs app.