You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+17-7Lines changed: 17 additions & 7 deletions
Original file line number
Diff line number
Diff line change
@@ -1,27 +1,34 @@
1
-
## Fonts for CircuitPython
1
+
#CircuitPython Fonts Bundle
2
2
3
3
<!-- SPDX-FileCopyrightText: 2023 Jeff Epler for Adafruit Industries -->
4
4
<!-- SPDX-License-Identifier: MIT -->
5
5
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
7
7
used in CircuitPython by simply importing them.
8
8
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):
10
12
11
13
```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
14
16
```
15
17
16
18
The font can be used like so:
17
19
```python
18
-
fromfont_free_mono_9_asciiimportFONTasMONO_9
20
+
fromfont_free_mono_9importFONTasMONO_9
19
21
from adafruit_display_text.bitmap_label import Label
20
22
21
23
# ...
22
24
label = Label(font=MONO_9, text="Hi Mom!")
23
25
```
24
26
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
+
25
32
## Adding new fonts
26
33
27
34
* 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
43
50
44
51
## Building locally
45
52
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):
0 commit comments