| 1 |
About this project |
| 2 |
================== |
| 3 |
|
| 4 |
Important things to know |
| 5 |
about ``bdflib`` and its development. |
| 6 |
|
| 7 |
Requirements |
| 8 |
------------ |
| 9 |
|
| 10 |
Python 3.8 or greater |
| 11 |
(earlier versions may work, but they are unsupported) |
| 12 |
|
| 13 |
``bdflib`` does not require anything outside the standard library. |
| 14 |
|
| 15 |
License |
| 16 |
------- |
| 17 |
|
| 18 |
``bdflib`` is published under the GNU General Public License version 3. |
| 19 |
|
| 20 |
Development |
| 21 |
----------- |
| 22 |
|
| 23 |
The source-code and issue tracker for ``bdflib`` are at |
| 24 |
https://gitlab.com/Screwtapello/bdflib |
| 25 |
|
| 26 |
Once you've checked out the ``bdflib`` source code, |
| 27 |
you can run the ``bdflib`` unit tests with: |
| 28 |
|
| 29 |
.. code-block:: console |
| 30 |
|
| 31 |
$ python3 -m unittest |
| 32 |
|
| 33 |
Alternatively, |
| 34 |
if you have `tox <https://pypi.org/project/tox/>`_ installed, |
| 35 |
you can just run: |
| 36 |
|
| 37 |
.. code-block:: console |
| 38 |
|
| 39 |
$ tox |
| 40 |
|
| 41 |
to run all the tests and build all the documentation. |
| 42 |
|
| 43 |
Further reading |
| 44 |
--------------- |
| 45 |
|
| 46 |
- `Bitmap Distribution Format version 2.1 |
| 47 |
<https://www.x.org/docs/BDF/bdf.pdf>`_ (PDF format) |
| 48 |
is the X11 version of the BDF specification, |
| 49 |
based on the Adobe standard. |
| 50 |
- `Glyph Bitmap Distribution Format (BDF) Specification version 2.2 |
| 51 |
<https://adobe-type-tools.github.io/font-tech-notes/pdfs/5005.BDF_Spec.pdf>`_ |
| 52 |
(PDF format) |
| 53 |
is the Adobe version of the BDF specification. |
| 54 |
Version 2.2 is backward-compatible with version 2.1, |
| 55 |
and adds extra features to support scripts with vertical text layout. |
| 56 |
``bdflib`` does not implement this version, |
| 57 |
but some things are better explained here than in the X11 version. |
| 58 |
- `X Logical Font Description Conventions |
| 59 |
<https://www.x.org/docs/XLFD/xlfd.pdf>`_ |
| 60 |
describes the extra font properties that X11 uses, |
| 61 |
above and beyond the basic BDF specification. |
| 62 |
- `BDF Fonts and Modern Linux |
| 63 |
<https://thristian.livejournal.com/90017.html>`_ |
| 64 |
describes practical concerns with making a BDF font |
| 65 |
that will be properly recognised by a modern Linux system. |