Anurag Thakur pushed to branch gsoc-anurag-docs-2023 at FreeType / FreeType
Commits:
-
a908e4d3
by Anurag Thakur at 2023-06-29T16:34:27+05:30
4 changed files:
Changes:
| ... | ... | @@ -654,7 +654,7 @@ endif () |
| 654 | 654 | # Packaging
|
| 655 | 655 | set(CPACK_PACKAGE_NAME ${CMAKE_PROJECT_NAME})
|
| 656 | 656 | set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "The FreeType font rendering library.")
|
| 657 | -set(CPACK_PACKAGE_DESCRIPTION_FILE "${CMAKE_CURRENT_SOURCE_DIR}/README")
|
|
| 657 | +set(CPACK_PACKAGE_DESCRIPTION_FILE "${CMAKE_CURRENT_SOURCE_DIR}/README.md")
|
|
| 658 | 658 | set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/LICENSE.TXT")
|
| 659 | 659 | |
| 660 | 660 | set(CPACK_PACKAGE_VERSION_MAJOR ${VERSION_MAJOR})
|
| 1 | -FreeType 2.13.1
|
|
| 2 | -===============
|
|
| 3 | - |
|
| 4 | -Homepage: https://www.freetype.org
|
|
| 5 | - |
|
| 6 | -FreeType is a freely available software library to render fonts.
|
|
| 7 | - |
|
| 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.
|
|
| 11 | - |
|
| 12 | -Please read the `docs/CHANGES` file, it contains IMPORTANT
|
|
| 13 | -INFORMATION.
|
|
| 14 | - |
|
| 15 | -Read the files `docs/INSTALL*` for installation instructions; see the
|
|
| 16 | -file `docs/LICENSE.TXT` for the available licenses.
|
|
| 17 | - |
|
| 18 | -For using FreeType's git repository instead of a distribution bundle,
|
|
| 19 | -please read file `README.git`. Note that you have to actually clone
|
|
| 20 | -the repository; using a snapshot will not work (in other words, don't
|
|
| 21 | -use gitlab's 'Download' button).
|
|
| 22 | - |
|
| 23 | -The FreeType 2 API reference is located in directory `docs/reference`;
|
|
| 24 | -use the file `index.html` as the top entry point. [Please note that
|
|
| 25 | -currently the search function for locally installed documentation
|
|
| 26 | -doesn't work due to cross-site scripting issues.]
|
|
| 27 | - |
|
| 28 | -Additional documentation is available as a separate package from our
|
|
| 29 | -sites. Go to
|
|
| 30 | - |
|
| 31 | - https://download.savannah.gnu.org/releases/freetype/
|
|
| 32 | - |
|
| 33 | -and download one of the following files.
|
|
| 34 | - |
|
| 35 | - freetype-doc-2.13.1.tar.xz
|
|
| 36 | - freetype-doc-2.13.1.tar.gz
|
|
| 37 | - ftdoc2131.zip
|
|
| 38 | - |
|
| 39 | -To view the documentation online, go to
|
|
| 40 | - |
|
| 41 | - https://www.freetype.org/freetype2/docs/
|
|
| 42 | - |
|
| 43 | - |
|
| 44 | -Mailing Lists
|
|
| 45 | --------------
|
|
| 46 | - |
|
| 47 | -The preferred way of communication with the FreeType team is using
|
|
| 48 | -e-mail lists.
|
|
| 49 | - |
|
| 50 | - general use and discussion: freetype@nongnu.org
|
|
| 51 | - engine internals, porting, etc.: freetype-devel@nongnu.org
|
|
| 52 | - announcements: freetype-announce@nongnu.org
|
|
| 53 | - git repository tracker: freetype-commit@nongnu.org
|
|
| 54 | - |
|
| 55 | -The lists are moderated; see
|
|
| 56 | - |
|
| 57 | - https://www.freetype.org/contact.html
|
|
| 58 | - |
|
| 59 | -how to subscribe.
|
|
| 60 | - |
|
| 61 | - |
|
| 62 | -Bugs
|
|
| 63 | -----
|
|
| 64 | - |
|
| 65 | -Please submit bug reports at
|
|
| 66 | - |
|
| 67 | - https://gitlab.freedesktop.org/freetype/freetype/-/issues
|
|
| 68 | - |
|
| 69 | -Alternatively, you might report bugs by e-mail to
|
|
| 70 | -`freetype-devel@nongnu.org`. Don't forget to send a detailed
|
|
| 71 | -explanation of the problem -- there is nothing worse than receiving a
|
|
| 72 | -terse message that only says 'it doesn't work'.
|
|
| 73 | - |
|
| 74 | - |
|
| 75 | -Patches
|
|
| 76 | --------
|
|
| 77 | - |
|
| 78 | -For larger changes please provide merge requests at
|
|
| 79 | - |
|
| 80 | - https://gitlab.freedesktop.org/freetype/freetype/-/merge_requests
|
|
| 81 | - |
|
| 82 | -Alternatively, you can send patches to the `freetype-devel@nongnu.org`
|
|
| 83 | -mailing list -- and thank you in advance for your work on improving
|
|
| 84 | -FreeType!
|
|
| 85 | - |
|
| 86 | -Details on the process can be found here:
|
|
| 87 | - |
|
| 88 | - https://www.freetype.org/developer.html#patches
|
|
| 89 | - |
|
| 90 | - |
|
| 91 | -Enjoy!
|
|
| 92 | - |
|
| 93 | - The FreeType Team
|
|
| 94 | - |
|
| 95 | -----------------------------------------------------------------------
|
|
| 96 | - |
|
| 97 | -Copyright (C) 2006-2023 by
|
|
| 98 | -David Turner, Robert Wilhelm, and Werner Lemberg.
|
|
| 99 | - |
|
| 100 | -This file is part of the FreeType project, and may only be used,
|
|
| 101 | -modified, and distributed under the terms of the FreeType project
|
|
| 102 | -license, LICENSE.TXT. By continuing to use, modify, or distribute
|
|
| 103 | -this file you indicate that you have read the license and understand
|
|
| 104 | -and accept it fully.
|
|
| 105 | - |
|
| 106 | - |
|
| 107 | ---- end of README --- |
| 1 | -README.git
|
|
| 2 | -==========
|
|
| 3 | - |
|
| 4 | - |
|
| 5 | -repository issues
|
|
| 6 | ------------------
|
|
| 7 | - |
|
| 8 | -FreeType's official repository site is
|
|
| 9 | - |
|
| 10 | - https://gitlab.freedesktop.org/freetype ,
|
|
| 11 | - |
|
| 12 | -from which the 'freetype.git' and 'freetype-demos.git' repositories
|
|
| 13 | -can be cloned in the usual way.
|
|
| 14 | - |
|
| 15 | - git clone https://gitlab.freedesktop.org/freetype/freetype.git
|
|
| 16 | - git clone https://gitlab.freedesktop.org/freetype/freetype-demos.git
|
|
| 17 | - |
|
| 18 | -If you want to use the Savannah mirror instead, you have to do a
|
|
| 19 | -slightly different incantation because the repository names contain
|
|
| 20 | -digit '2' for historical reasons.
|
|
| 21 | - |
|
| 22 | - git clone \
|
|
| 23 | - https://git.savannah.nongnu.org/git/freetype/freetype2.git \
|
|
| 24 | - freetype
|
|
| 25 | - git clone \
|
|
| 26 | - https://git.savannah.nongnu.org/git/freetype/freetype2-demos.git \
|
|
| 27 | - freetype-demos
|
|
| 28 | - |
|
| 29 | - |
|
| 30 | -standard builds with `configure`
|
|
| 31 | ---------------------------------
|
|
| 32 | - |
|
| 33 | -The git repository doesn't contain pre-built configuration scripts for
|
|
| 34 | -UNIXish platforms. To generate them say
|
|
| 35 | - |
|
| 36 | - sh autogen.sh
|
|
| 37 | - |
|
| 38 | -which in turn depends on the following packages:
|
|
| 39 | - |
|
| 40 | - automake (1.10.1)
|
|
| 41 | - libtool (2.2.4)
|
|
| 42 | - autoconf (2.62)
|
|
| 43 | - |
|
| 44 | -The versions given in parentheses are known to work. Newer versions
|
|
| 45 | -should work too, of course. Note that `autogen.sh` also sets up
|
|
| 46 | -proper file permissions for the `configure` and auxiliary scripts.
|
|
| 47 | - |
|
| 48 | -The `autogen.sh` script checks whether the versions of the above three
|
|
| 49 | -tools match the numbers above. Otherwise it will complain and suggest
|
|
| 50 | -either upgrading or using environment variables to point to more
|
|
| 51 | -recent versions of the required tools.
|
|
| 52 | - |
|
| 53 | -Note that `aclocal` is provided by the 'automake' package on Linux,
|
|
| 54 | -and that `libtoolize` is called `glibtoolize` on Darwin (OS X).
|
|
| 55 | - |
|
| 56 | - |
|
| 57 | -alternative build methods
|
|
| 58 | --------------------------
|
|
| 59 | - |
|
| 60 | -For static builds that don't use platform-specific optimizations, no
|
|
| 61 | -configure script is necessary at all; saying
|
|
| 62 | - |
|
| 63 | - make setup ansi
|
|
| 64 | - make
|
|
| 65 | - |
|
| 66 | -should work on all platforms that have GNU `make` (or `makepp`).
|
|
| 67 | - |
|
| 68 | -A build with `cmake` or `meson` can be done directly from the git
|
|
| 69 | -repository. However, if you want to use the `FT_DEBUG_LOGGING` macro
|
|
| 70 | -(see file `docs/DEBUG` for more information) it is currently mandatory
|
|
| 71 | -to execute `autogen.sh` in advance; this script clones the 'dlg' git
|
|
| 72 | -submodule and copies some files into FreeType's source tree.
|
|
| 73 | - |
|
| 74 | - |
|
| 75 | -Code of Conduct
|
|
| 76 | ----------------
|
|
| 77 | - |
|
| 78 | -Please note that this project is released with a Contributor Code of
|
|
| 79 | -Conduct (CoC). By participating in this project you agree to abide by
|
|
| 80 | -its terms, which you can find in the following link:
|
|
| 81 | - |
|
| 82 | - https://www.freedesktop.org/wiki/CodeOfConduct
|
|
| 83 | - |
|
| 84 | -CoC issues may be raised to the project maintainers at the following
|
|
| 85 | -address:
|
|
| 86 | - |
|
| 87 | - wl@gnu.org
|
|
| 88 | - apodtele@gmail.com
|
|
| 89 | - |
|
| 90 | -----------------------------------------------------------------------
|
|
| 91 | - |
|
| 92 | -Copyright (C) 2005-2023 by
|
|
| 93 | -David Turner, Robert Wilhelm, and Werner Lemberg.
|
|
| 94 | - |
|
| 95 | -This file is part of the FreeType project, and may only be used,
|
|
| 96 | -modified, and distributed under the terms of the FreeType project
|
|
| 97 | -license, LICENSE.TXT. By continuing to use, modify, or distribute
|
|
| 98 | -this file you indicate that you have read the license and understand
|
|
| 99 | -and accept it fully.
|
|
| 100 | - |
|
| 101 | - |
|
| 102 | ---- end of README.git --- |
| 1 | +# FreeType ![Badge Version]
|
|
| 2 | + |
|
| 3 | +*A freely available software library to render fonts.*
|
|
| 4 | + |
|
| 5 | +---
|
|
| 6 | + |
|
| 7 | + **[❮ Website ❯][Website]**
|
|
| 8 | + **[❮ Install ❯][Install]**
|
|
| 9 | + **[❮ Changes ❯][Changes]**
|
|
| 10 | + **[❮ Documentation ❯][Documentation]**
|
|
| 11 | + **[❮ API ❯][API]**
|
|
| 12 | + **[❮ License ❯][License]**
|
|
| 13 | + |
|
| 14 | +---
|
|
| 15 | + |
|
| 16 | +**FreeType** is a **C** library, designed to be small, efficient, highly
|
|
| 17 | +customizable, and portable while capable of producing high-quality
|
|
| 18 | +output (glyph images) of most vector and bitmap font formats.
|
|
| 19 | + |
|
| 20 | +---
|
|
| 21 | + |
|
| 22 | + |
|
| 23 | + |
|
| 24 | +# Documentation
|
|
| 25 | +The FreeType 2 API reference for the latest release, along with additional
|
|
| 26 | +documentation can be found online at:
|
|
| 27 | + |
|
| 28 | +>https://freetype.org/freetype2/docs/documentation.html
|
|
| 29 | + |
|
| 30 | +Refer to [DOCGUIDE] for more information.
|
|
| 31 | + |
|
| 32 | + |
|
| 33 | +# Source Mirrors
|
|
| 34 | + |
|
| 35 | +FreeType's official git repository is located at
|
|
| 36 | + |
|
| 37 | +>https://gitlab.freedesktop.org/freetype
|
|
| 38 | + |
|
| 39 | +from which the 'freetype.git' and 'freetype-demos.git' repositories
|
|
| 40 | +can be cloned in the usual way.
|
|
| 41 | + |
|
| 42 | +FreeType:
|
|
| 43 | + |
|
| 44 | +```bash
|
|
| 45 | +git clone https://gitlab.freedesktop.org/freetype/freetype.git
|
|
| 46 | +```
|
|
| 47 | + |
|
| 48 | +FreeType-demos:
|
|
| 49 | +```bash
|
|
| 50 | +git clone https://gitlab.freedesktop.org/freetype/freetype-demos.git
|
|
| 51 | +```
|
|
| 52 | + |
|
| 53 | +If you want to use the Savannah mirror instead, you have to do a
|
|
| 54 | +slightly different incantation because the repository names contain
|
|
| 55 | +digit '2' for historical reasons.
|
|
| 56 | + |
|
| 57 | +```bash
|
|
| 58 | +git clone https://git.savannah.nongnu.org/git/freetype/freetype2.git
|
|
| 59 | +```
|
|
| 60 | + |
|
| 61 | +```bash
|
|
| 62 | +git clone https://git.savannah.nongnu.org/git/freetype/freetype2-demos.git
|
|
| 63 | +```
|
|
| 64 | + |
|
| 65 | +# Compiling FreeType
|
|
| 66 | +FreeType supports compilation via meson, GNU make and CMake
|
|
| 67 | + |
|
| 68 | +Refer to [Install] for more information.
|
|
| 69 | + |
|
| 70 | +# Licensing
|
|
| 71 | +FreeType is dual-licensed under the FTL and GPLv2.
|
|
| 72 | + |
|
| 73 | +Refer to [License] for more information.
|
|
| 74 | + |
|
| 75 | +# Reporting Issues
|
|
| 76 | +Please submit bug reports at
|
|
| 77 | + |
|
| 78 | +>https://gitlab.freedesktop.org/freetype/freetype/-/issues
|
|
| 79 | + |
|
| 80 | +If you have suggestions for improving FreeType, they should be sent
|
|
| 81 | +to the `freetype-devel` mailing list.
|
|
| 82 | + |
|
| 83 | + |
|
| 84 | +# Improving FreeType
|
|
| 85 | +For instructions on compiling FreeType, see [Install].
|
|
| 86 | + |
|
| 87 | +Please send merge requests to our gitlab repo at:
|
|
| 88 | + |
|
| 89 | +>https://gitlab.freedesktop.org/freetype/freetype/
|
|
| 90 | + |
|
| 91 | +Alternatively, you can send patches to the `freetype-devel` mailing list.
|
|
| 92 | +Details on the process can be found here:
|
|
| 93 | + |
|
| 94 | +>https://www.freetype.org/developer.html#patches
|
|
| 95 | + |
|
| 96 | +Any non-trivial contribution should first be discussed with the maintainers
|
|
| 97 | +via the `freetype-devel` mailing list.
|
|
| 98 | + |
|
| 99 | +# Contact
|
|
| 100 | +The preferred way of communication with the FreeType team is using
|
|
| 101 | +mailing lists.
|
|
| 102 | + |
|
| 103 | +*↳* [*How do I subscribe?*][Contact]
|
|
| 104 | + |
|
| 105 | + |
|
| 106 | +| Email | Details |
|
|
| 107 | +| --- | --- |
|
|
| 108 | +|freetype@nongnu.org| General use and discussion|
|
|
| 109 | +|freetype-devel@nongnu.org| Engine internals, Porting etc|
|
|
| 110 | +|freetype-announce@nongnu.org| Announcements|
|
|
| 111 | +|freetype-commit@nongnu.org| Git repository track|
|
|
| 112 | + |
|
| 113 | +**The lists are moderated**
|
|
| 114 | + |
|
| 115 | +# Code of Conduct
|
|
| 116 | +Please note that this project is released with a Contributor Code of
|
|
| 117 | +Conduct (CoC). By participating in this project you agree to abide by
|
|
| 118 | +its terms, which you can find in the following link:
|
|
| 119 | + |
|
| 120 | +>https://www.freedesktop.org/wiki/CodeOfConduct
|
|
| 121 | + |
|
| 122 | +CoC issues may be raised to the project maintainers at the following
|
|
| 123 | +address:
|
|
| 124 | + |
|
| 125 | + - wl@gnu.org
|
|
| 126 | + - apodtele@gmail.com
|
|
| 127 | + |
|
| 128 | +---
|
|
| 129 | +```
|
|
| 130 | +Copyright (C) 2006-2021 by
|
|
| 131 | +David Turner, Robert Wilhelm, and Werner Lemberg.
|
|
| 132 | + |
|
| 133 | +This file is part of the FreeType project, and may only be used,
|
|
| 134 | +modified, and distributed under the terms of the FreeType project
|
|
| 135 | +license, COPYING.md. By continuing to use, modify, or distribute
|
|
| 136 | +this file you indicate that you have read the license and understand
|
|
| 137 | +and accept it fully.
|
|
| 138 | +```
|
|
| 139 | + |
|
| 140 | + |
|
| 141 | +<!----------------------------------------------------------------------------->
|
|
| 142 | + |
|
| 143 | +[Website]: https://www.freetype.org
|
|
| 144 | +[Issues]: https://gitlab.freedesktop.org/freetype/freetype/-/issues
|
|
| 145 | +[Contact]: https://www.freetype.org/contact.html
|
|
| 146 | +[Merge Request]: https://gitlab.freedesktop.org/freetype/freetype/-/merge_requests
|
|
| 147 | +[Patches]: https://www.freetype.org/developer.html#patches
|
|
| 148 | +[Documentation]: https://freetype.org/freetype2/docs/documentation.html
|
|
| 149 | +[Releases]: https://download.savannah.gnu.org/releases/freetype/
|
|
| 150 | +[API]: https://freetype.org/freetype2/docs/reference/index.html
|
|
| 151 | + |
|
| 152 | + |
|
| 153 | +[Documentation XZ]: https://download.savannah.gnu.org/releases/freetype/freetype-2.11.1.tar.xz
|
|
| 154 | +[Documentation GZ]: https://download.savannah.gnu.org/releases/freetype/freetype-2.11.1.tar.gz
|
|
| 155 | +[Documentation ZIP]: https://download.savannah.gnu.org/releases/freetype/ftdmo2111.zip
|
|
| 156 | + |
|
| 157 | +[Install]: ./docs/INSTALL
|
|
| 158 | +[Changes]: ./docs/CHANGES
|
|
| 159 | +[License]: ./LICENSE.TXT
|
|
| 160 | +[DOCGUIDE]: ./docs/DOCGUIDE
|
|
| 161 | + |
|
| 162 | +[Badge Version]: https://gitlab.freedesktop.org/freetype/freetype/-/badges/release.svg |