src/raqm-0.10.1/README.md

0001 Raqm
0002 ====
0003
0004 [![Build](https://github.com/HOST-Oman/libraqm/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/HOST-Oman/libraqm/actions)
0005
0006 Raqm is a small library that encapsulates the logic for complex text layout and
0007 provides a convenient API.
0008
0009 It currently provides bidirectional text support (using [FriBiDi][1] or
0010 [SheenBidi][2]), shaping (using [HarfBuzz][3]), and proper script itemization.
0011 As a result, Raqm can support most writing systems covered by Unicode.
0012
0013 The documentation can be accessed on the web at:
0014 > https://host-oman.github.io/libraqm/
0015
0016 Raqm (Arabic: رَقْم) is writing, also number or digit and the Arabic word for
0017 digital (رَقَمِيّ) shares the same root, so it is a play on “digital writing”.
0018
0019 Building
0020 --------
0021
0022 Raqm depends on the following libraries:
0023 * [FreeType][4]
0024 * [HarfBuzz][3]
0025 * [FriBiDi][1] or [SheenBidi][2]
0026
0027 To build the documentation you will also need:
0028 * [GTK-Doc][5]
0029
0030 To install dependencies on Fedora:
0031
0032     sudo dnf install freetype-devel harfbuzz-devel fribidi-devel meson gtk-doc
0033
0034 To install dependencies on Ubuntu:
0035
0036     sudo apt-get install libfreetype6-dev libharfbuzz-dev libfribidi-dev meson gtk-doc-tools
0037
0038 On Mac OS X you can use Homebrew:
0039
0040     brew install freetype harfbuzz fribidi meson gtk-doc
0041     export XML_CATALOG_FILES="/usr/local/etc/xml/catalog" # for the docs
0042
0043 Once you have the source code and the dependencies, you can proceed to build.
0044 To do that, run the customary sequence of commands in the source code
0045 directory:
0046
0047     $ meson build
0048     $ ninja -C build
0049     $ ninja -C build install
0050
0051 To build the documentation, pass `-Ddocs=true` to the `meson`.
0052
0053 To run the tests:
0054
0055     $ ninja -C build test
0056
0057 Contributing
0058 ------------
0059
0060 Once you have made a change that you are happy with, contribute it back, we’ll
0061 be happy to integrate it! Just fork the repository and make a pull request.
0062
0063 Projects using Raqm
0064 -------------------
0065
0066 1. [ImageMagick](https://github.com/ImageMagick/ImageMagick)
0067 2. [LibGD](https://github.com/libgd/libgd)
0068 3. [FontView](https://github.com/googlei18n/fontview)
0069 4. [Pillow](https://github.com/python-pillow)
0070 5. [mplcairo](https://github.com/anntzer/mplcairo)
0071 6. [CEGUI](https://github.com/cegui/cegui)
0072
0073 The following projects have patches to support complex text layout using Raqm:
0074
0075 2. SDL_ttf: https://bugzilla.libsdl.org/show_bug.cgi?id=3211
0076 3. Pygame: https://bitbucket.org/pygame/pygame/pull-requests/52
0077 4. Blender: https://developer.blender.org/D1809
0078
0079
0080
0081 [1]: https://github.com/fribidi/fribidi
0082 [2]: https://github.com/Tehreer/SheenBidi
0083 [3]: https://github.com/harfbuzz/harfbuzz
0084 [4]: https://freetype.org/
0085 [5]: https://www.gtk.org/gtk-doc