Skip to content

Commit af94636

Browse files
authored
Merge pull request #2 from jepler/prepare-handoff
Prepare handoff
2 parents 9e0bec4 + 2f5d055 commit af94636

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

README.md

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,34 @@
1-
## Fonts for CircuitPython
1+
# CircuitPython Fonts Bundle
22

33
<!-- SPDX-FileCopyrightText: 2023 Jeff Epler for Adafruit Industries -->
44
<!-- SPDX-License-Identifier: MIT -->
55

6-
The goal of this repository is to generate a number of fonts that can be
6+
The repository generates a large number of bitmap fonts that can be
77
used in CircuitPython by simply importing them.
88

9-
It can be used with (circup)[https://pypi.org/project/circup/] for easy installation:
9+
It can be used with [circup](https://pypi.org/project/circup/) for easy installation.
10+
11+
Once you have installed circup and connected to a board, simply install the desired font(s):
1012

1113
```sh
12-
circup bundle-add jepler/circuitpython-fonts # You only need to do this once
13-
circup install font_free_mono_9_ascii
14+
circup bundle-add adafruit/circuitpython-fonts # You only need to do this once
15+
circup install font_free_mono_9
1416
```
1517

1618
The font can be used like so:
1719
```python
18-
from font_free_mono_9_ascii import FONT as MONO_9
20+
from font_free_mono_9 import FONT as MONO_9
1921
from adafruit_display_text.bitmap_label import Label
2022

2123
# ...
2224
label = Label(font=MONO_9, text="Hi Mom!")
2325
```
2426

27+
If you don't use circup, then simply grab the appropriate bundle from
28+
the Releases page. Unzip it, and then copy the desired folder(s) to your
29+
CircuitPython device. If you use a manual installation method, you'll also
30+
need to install `adafruit_bitmap_font` from the [Adfruit CircuitPython Bundle](https://github.com/adafruit/Adafruit_CircuitPython_Bundle/).
31+
2532
## Adding new fonts
2633

2734
* Copy the font into `fonts/`
@@ -43,6 +50,9 @@ In any case, you will likely need to manually test font sizes until you find the
4350

4451
## Building locally
4552

46-
The build process requires two programs to build: otf2bdf (from debian/ubuntu pacakage otf2bdf) and bdftopcf (from debian/ubuntu package xfonts-utils). Other Linux distributions and other operating systems will have different ways to aquire these tools, which may require building them from source.
53+
The build process requires these programs (instructions to install on Debian and Ubuntu Linux in parentheses):
54+
* otf2bdf (sudo apt install otf2bdf)
55+
* bdftopcf (sudo apt install xfonts-utils)
56+
* circuitpython-build-bundles (sudo apt install pipx; pipx install circuitpython-build-tools)
4757

4858
Once the dependencies are installed, simply invoke `build.py` and after a few minutes you will get a fresh font bundle in `dist/`.

0 commit comments

Comments
 (0)