zephyr/samples/display/cfb_custom_font
David B. Kinder 505cc2bb0e doc: use :zephyr_file: where appropriate
A new role :zephyr_file: is available that renders to a link to the file
or folder in GitHub.  Find appropriate references using :file: and
convert to :zephyr_file: to take advantage of its linking capability.

Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
2019-03-09 09:50:27 -05:00
..
boards
fonts
src
CMakeLists.txt cmake: Drop all in-tree usage 'set_conf_file' 2019-03-01 09:44:09 +01:00
README.rst doc: use :zephyr_file: where appropriate 2019-03-09 09:50:27 -05:00
prj.conf
sample.yaml

README.rst

.. _cfb_custom_fonts:

Custom Fonts
############

Overview
********
A simple example showing how to generate Character Framebuffer (CFB)
font headers automatically at build time.

This example generates a font with font elements for 6 sided dice from
a PNG image, and then uses the generated header (``cfb_font_dice.h``)
to show the font elements on the display of a supported board.

The source code for this sample application can be found at:
:zephyr_file:`samples/display/cfb_custom_font`.

Building and Running
********************

There are different configuration files in the cfb_custom_font
directory:

- :file:`prj.conf`
  Generic config file, normally you should use this.

- :file:`boards/reel_board.conf`
  This overlay config enables support for SSD1673 display controller
  on the reel_board.


Example building for the reel_board with SSD1673 display support:

.. zephyr-app-commands::
   :zephyr-app: samples/display/cfb_custom_font
   :host-os: unix
   :board: reel_board
   :goals: flash
   :compact: