furnace/extern/freetype/docs
tildearrow b379125587 GUI: experimental FreeType font renderer
disabled by default until I feel happy
2023-10-15 20:15:33 -05:00
..
oldlogs GUI: experimental FreeType font renderer 2023-10-15 20:15:33 -05:00
reference GUI: experimental FreeType font renderer 2023-10-15 20:15:33 -05:00
CHANGES GUI: experimental FreeType font renderer 2023-10-15 20:15:33 -05:00
CMAKE GUI: experimental FreeType font renderer 2023-10-15 20:15:33 -05:00
CUSTOMIZE GUI: experimental FreeType font renderer 2023-10-15 20:15:33 -05:00
DEBUG GUI: experimental FreeType font renderer 2023-10-15 20:15:33 -05:00
DOCGUIDE GUI: experimental FreeType font renderer 2023-10-15 20:15:33 -05:00
formats.txt GUI: experimental FreeType font renderer 2023-10-15 20:15:33 -05:00
freetype-config.1 GUI: experimental FreeType font renderer 2023-10-15 20:15:33 -05:00
FTL.TXT GUI: experimental FreeType font renderer 2023-10-15 20:15:33 -05:00
GPLv2.TXT GUI: experimental FreeType font renderer 2023-10-15 20:15:33 -05:00
INSTALL GUI: experimental FreeType font renderer 2023-10-15 20:15:33 -05:00
INSTALL.ANY GUI: experimental FreeType font renderer 2023-10-15 20:15:33 -05:00
INSTALL.CROSS GUI: experimental FreeType font renderer 2023-10-15 20:15:33 -05:00
INSTALL.GNU GUI: experimental FreeType font renderer 2023-10-15 20:15:33 -05:00
INSTALL.MAC GUI: experimental FreeType font renderer 2023-10-15 20:15:33 -05:00
INSTALL.UNIX GUI: experimental FreeType font renderer 2023-10-15 20:15:33 -05:00
INSTALL.VMS GUI: experimental FreeType font renderer 2023-10-15 20:15:33 -05:00
MAKEPP GUI: experimental FreeType font renderer 2023-10-15 20:15:33 -05:00
PROBLEMS GUI: experimental FreeType font renderer 2023-10-15 20:15:33 -05:00
raster.txt GUI: experimental FreeType font renderer 2023-10-15 20:15:33 -05:00
README GUI: experimental FreeType font renderer 2023-10-15 20:15:33 -05:00
release GUI: experimental FreeType font renderer 2023-10-15 20:15:33 -05:00
TODO GUI: experimental FreeType font renderer 2023-10-15 20:15:33 -05:00
VERSIONS.TXT GUI: experimental FreeType font renderer 2023-10-15 20:15:33 -05:00

After saying `make refdoc' or `make refdoc-venv' the `reference/' directory
contains the FreeType API reference.  You need Python >= 3.5 and pip to make
this target.

There are two ways to generate the documentation:

1. Using `make refdoc':

    - Ensure `python' and `pip' are available.
    - Install pip package `docwriter' with `pip install --user docwriter'.
    - Make target with `make refdoc'.
    - This target can be run offline once required packages are installed.

2. Using `make refdoc-venv' (requires internet access):

    - Ensure `python', `pip' and Python package `virtualenv' are available.
    - Make target with `make refdoc-venv'.
    - This may or may not require internet access every time depending on
    pip and system caching.

Some troubleshooting tips:

* Regularly run `pip install --upgrade docwriter' to check for updates which
may include bug fixes.

* `Docwriter' does not support Python 2.  Ensure that Python >= 3.5 is
installed and available as `python3'/`python'.

* Ensure that `docwriter' is installed in the same Python target that
`make refdoc' uses (python3/python).

* If none of this works, send a mail to `freetype-devel@nongnu.org' or file
an issue at `https://github.com/freetype/docwriter/issues'.