diff --git a/README.rst b/README.rst index 8372bec..2921ccc 100644 --- a/README.rst +++ b/README.rst @@ -13,7 +13,7 @@ Introduction :target: https://github.com/adafruit/Adafruit_CircuitPython_Bitmap_Font/actions/ :alt: Build Status -Loads bitmap fonts into CircuitPython's displayio. BDF files are well supported. PCF and TTF +Loads bitmap fonts into CircuitPython's displayio. BDF and PCF files are well supported. TTF support is not yet complete. Dependencies @@ -53,14 +53,23 @@ To install in a virtual environment in your current project: Usage Example ============= -.. code-block::python +.. code-block:: python from adafruit_bitmap_font import bitmap_font from displayio import Bitmap - font = bitmap_font.load_font("scientifica-11.bdf", Bitmap) + font = bitmap_font.load_font("fonts/Arial-16.bdf", Bitmap) print(font.get_glyph(ord("A"))) +Creating Fonts +============== + +See `this learn guide `_ for more information about building custom fornt files + +The command line tool :code:`otf2bdf` can be used make bdf files for use with this library. + +The command line tool :code:`bdftopcf` can be used make pcf files for use with this library. + Contributing ============ diff --git a/examples/bitmap_font_displayio_simpletest.py b/examples/bitmap_font_displayio_simpletest.py index 715f205..13715a6 100644 --- a/examples/bitmap_font_displayio_simpletest.py +++ b/examples/bitmap_font_displayio_simpletest.py @@ -11,7 +11,16 @@ import displayio from adafruit_bitmap_font import bitmap_font -font = bitmap_font.load_font("fonts/Arial-16.bdf") +# use built in display (PyPortal, PyGamer, PyBadge, CLUE, etc.) +# see guide for setting up external displays (TFT / OLED breakouts, RGB matrices, etc.) +# https://learn.adafruit.com/circuitpython-display-support-using-displayio/display-and-display-bus +display = board.DISPLAY + +# try uncommenting different font files if you like +font_file = "fonts/Arial-16.bdf" +# font_file = "fonts/yasashi24.pcf" + +font = bitmap_font.load_font(font_file) bitmap = displayio.Bitmap(320, 240, 2) @@ -59,7 +68,7 @@ group.append(tile_grid) # Add the Group to the Display -board.DISPLAY.show(group) +display.show(group) while True: pass diff --git a/examples/bitmap_font_label_magtag.py b/examples/bitmap_font_label_magtag.py index e6685b2..6c352a0 100644 --- a/examples/bitmap_font_label_magtag.py +++ b/examples/bitmap_font_label_magtag.py @@ -15,9 +15,13 @@ # wait until we can refresh the display time.sleep(display.time_to_refresh) +# try uncommenting different font files if you like +font_file = "fonts/Arial-16.bdf" +# font_file = "fonts/yasashi24.pcf" + # Set text, font, and color text = "HELLO WORLD\nbitmap_font example" -font = bitmap_font.load_font("fonts/Arial-16.bdf") +font = bitmap_font.load_font(font_file) color = 0xFFFFFF background_color = 0x999999 diff --git a/examples/bitmap_font_label_simpletest.py b/examples/bitmap_font_label_simpletest.py index 1c134ee..e209d4c 100644 --- a/examples/bitmap_font_label_simpletest.py +++ b/examples/bitmap_font_label_simpletest.py @@ -7,11 +7,18 @@ from adafruit_display_text import label from adafruit_bitmap_font import bitmap_font +# use built in display (PyPortal, PyGamer, PyBadge, CLUE, etc.) +# see guide for setting up external displays (TFT / OLED breakouts, RGB matrices, etc.) +# https://learn.adafruit.com/circuitpython-display-support-using-displayio/display-and-display-bus display = board.DISPLAY +# try uncommenting different font files if you like +font_file = "fonts/Arial-16.bdf" +# font_file = "fonts/yasashi24.pcf" + # Set text, font, and color text = "HELLO WORLD" -font = bitmap_font.load_font("fonts/Arial-16.bdf") +font = bitmap_font.load_font(font_file) color = 0xFF00FF # Create the tet label