|
1 | | - FreeType 2.6.2 |
2 | | - ============== |
| 1 | +After saying `make refdoc' or `make refdoc-venv' the `reference/' directory |
| 2 | +contains the FreeType API reference. You need Python >= 3.5 and pip to make |
| 3 | +this target. |
3 | 4 |
|
4 | | - Homepage: http://www.freetype.org |
| 5 | +There are two ways to generate the documentation: |
5 | 6 |
|
6 | | - FreeType is a freely available software library to render fonts. |
| 7 | +1. Using `make refdoc': |
7 | 8 |
|
8 | | - It is written in C, designed to be small, efficient, highly |
9 | | - customizable, and portable while capable of producing high-quality |
10 | | - output (glyph images) of most vector and bitmap font formats. |
| 9 | + - Ensure `python' and `pip' are available. |
| 10 | + - Install pip package `docwriter' with `pip install --user docwriter'. |
| 11 | + - Make target with `make refdoc'. |
| 12 | + - This target can be run offline once required packages are installed. |
11 | 13 |
|
12 | | - Please read the docs/CHANGES file, it contains IMPORTANT |
13 | | - INFORMATION. |
| 14 | +2. Using `make refdoc-venv' (requires internet access): |
14 | 15 |
|
15 | | - Read the files `docs/INSTALL*' for installation instructions; see |
16 | | - the file `docs/LICENSE.TXT' for the available licenses. |
| 16 | + - Ensure `python', `pip' and Python package `virtualenv' are available. |
| 17 | + - Make target with `make refdoc-venv'. |
| 18 | + - This may or may not require internet access every time depending on |
| 19 | + pip and system caching. |
17 | 20 |
|
18 | | - The FreeType 2 API reference is located in `docs/reference'; use the |
19 | | - file `ft2-toc.html' as the top entry point. Additional |
20 | | - documentation is available as a separate package from our sites. Go |
21 | | - to |
| 21 | +This also works with Jam: Just type `jam refdoc' in the main directory. |
22 | 22 |
|
23 | | - http://download.savannah.gnu.org/releases/freetype/ |
| 23 | +Some troubleshooting tips: |
24 | 24 |
|
25 | | - and download one of the following files. |
| 25 | +* Regularly run `pip install --upgrade docwriter' to check for updates which |
| 26 | +may include bug fixes. |
26 | 27 |
|
27 | | - freetype-doc-2.6.2.tar.bz2 |
28 | | - freetype-doc-2.6.2.tar.gz |
29 | | - ftdoc262.zip |
| 28 | +* `Docwriter' does not support Python 2. Ensure that Python >= 3.5 is |
| 29 | +installed and available as `python3'/`python'. |
30 | 30 |
|
31 | | - To view the documentation online, go to |
| 31 | +* Ensure that `docwriter' is installed in the same Python target that |
| 32 | +`make refdoc' uses (python3/python). |
32 | 33 |
|
33 | | - http://www.freetype.org/freetype2/documentation.html |
34 | | - |
35 | | - |
36 | | - Mailing Lists |
37 | | - ============= |
38 | | - |
39 | | - The preferred way of communication with the FreeType team is using |
40 | | - e-mail lists. |
41 | | - |
42 | | - general use and discussion: [email protected] |
43 | | - engine internals, porting, etc.: [email protected] |
44 | | - |
45 | | - git repository tracker: [email protected] |
46 | | - |
47 | | - The lists are moderated; see |
48 | | - |
49 | | - http://www.freetype.org/contact.html |
50 | | - |
51 | | - how to subscribe. |
52 | | - |
53 | | - |
54 | | - Bugs |
55 | | - ==== |
56 | | - |
57 | | - Please submit bug reports at |
58 | | - |
59 | | - https://savannah.nongnu.org/bugs/?group=freetype |
60 | | - |
61 | | - Alternatively, you might report bugs by e-mail to |
62 | | - ` [email protected]'. Don't forget to send a detailed |
63 | | - explanation of the problem -- there is nothing worse than receiving |
64 | | - a terse message that only says `it doesn't work'. |
65 | | - |
66 | | - |
67 | | - Enjoy! |
68 | | - |
69 | | - |
70 | | - The FreeType Team |
71 | | - |
72 | | ----------------------------------------------------------------------- |
73 | | - |
74 | | -Copyright 2006-2015 by |
75 | | -David Turner, Robert Wilhelm, and Werner Lemberg. |
76 | | - |
77 | | -This file is part of the FreeType project, and may only be used, |
78 | | -modified, and distributed under the terms of the FreeType project |
79 | | -license, LICENSE.TXT. By continuing to use, modify, or distribute |
80 | | -this file you indicate that you have read the license and understand |
81 | | -and accept it fully. |
82 | | - |
83 | | - |
84 | | ---- end of README --- |
| 34 | +* If none of this works, send a mail to ` [email protected]' or file |
| 35 | +an issue at `https://github.com/freetype/docwriter/issues'. |
0 commit comments