@@ -35,13 +35,20 @@ will also find Win32/Win64 binary bundles that include `libharfbuzz` DLL,
3535` hb-view.exe ` , ` hb-shape.exe ` , and all dependencies.
3636
3737The canonical source tree is available on [ github] [ 4 ] .
38+ Both development and user support discussion around HarfBuzz happens on
39+ [ github] [ 4 ] as well.
3840
3941The API that comes with ` hb.h ` will not change incompatibly. Other, peripheral,
4042headers are more likely to go through minor modifications, but again, we do our
4143best to never change API in an incompatible way. We will never break the ABI.
4244
43- If you are not sure whether Pango or HarfBuzz is right for you, read [ Pango vs
44- HarfBuzz] [ 5 ] .
45+ The API and ABI are stable even across major version number jumps. In fact,
46+ current HarfBuzz is API/ABI compatible all the way back to the 0.9.x series.
47+ If one day we need to break the API/ABI, that would be called a new a library.
48+
49+ As such, we bump the major version number only when we add major new features,
50+ the minor version when there is new API, and the micro version when there
51+ are bug fixes.
4552
4653## Development
4754
@@ -51,26 +58,34 @@ For custom configurations, see [CONFIG.md](CONFIG.md).
5158
5259For testing and profiling, see [ TESTING.md] ( TESTING.md ) .
5360
61+ For using with Python, see [ README.python.md] ( README.python.md ) . There is also [ uharfbuzz] ( https://github.com/harfbuzz/uharfbuzz ) .
62+
5463For cross-compiling to Windows from Linux or macOS, see [ README.mingw.md] ( README.mingw.md ) .
5564
65+ To report bugs or submit patches please use [ github] [ 4 ] issues and pull-requests.
66+
67+ ### Developer documents
68+
5669To get a better idea of where HarfBuzz stands in the text rendering stack you
5770may want to read [ State of Text Rendering 2024] [ 6 ] .
5871Here are a few presentation slides about HarfBuzz at the
5972Internationalization and Unicode Conference over the years:
6073
61- * November 2014, [ Unicode, OpenType, and HarfBuzz: Closing the Circle] [ 7 ] ,
62- * October 2012, [ HarfBuzz, The Free and Open Text Shaping Engine] [ 8 ] ,
63- * October 2009, [ HarfBuzz: the Free and Open Shaping Engine] [ 9 ] .
64-
65- Both development and user support discussion around HarfBuzz happens on the
66- [ github] [ 4 ] .
74+ - November 2014, [ Unicode, OpenType, and HarfBuzz: Closing the Circle] [ 7 ] ,
75+ - October 2012, [ HarfBuzz, The Free and Open Text Shaping Engine] [ 8 ] ,
76+ - October 2009, [ HarfBuzz: the Free and Open Shaping Engine] [ 9 ] .
6777
68- To report bugs or submit patches please use [ github ] [ 4 ] issues and
69- pull-requests.
78+ More presentations and papers are available on [ behdad ] [ 11 ] 's website.
79+ In particular, the following documents are relevant to HarfBuzz development:
7080
71- For a comparison of old vs new HarfBuzz memory consumption see [ this] [ 10 ] .
81+ - 2025 — HarfBuzz Study: Caching — [ Paper] [ 12 ]
82+ - 2025 — HarfBuzz Study: ` hb-decycler ` — [ Paper] [ 13 ]
83+ - 2022 — HarfBuzz Study: ` hb-iter ` — [ Paper] [ 14 ]
84+ - 2022 — HarfBuzz Study: A C library written in C++ — [ Paper] [ 15 ]
85+ - 2022 — HarfBuzz Study: PackTab: A static integer table packer — [ Paper] [ 16 ]
86+ - 2014 — Reflections on Building the HarfBuzz Indic Shaper — [ Paper] [ 17 ]
87+ - 2012 — HarfBuzz Memory Consumption — [ Paper] [ 10 ]
7288
73- <!-- See past and upcoming [HarfBuzz Hackfests](https://freedesktop.org/wiki/Software/HarfBuzz/Hackfests/)!-->
7489
7590## Name
7691
@@ -98,9 +113,15 @@ transliterated using the Latin script. It also means "talkative" or
98113[ 2 ] : https://developer.apple.com/fonts/TrueType-Reference-Manual/RM06/Chap6AATIntro.html
99114[ 3 ] : https://github.com/harfbuzz/harfbuzz/releases
100115[ 4 ] : https://github.com/harfbuzz/harfbuzz
101- [ 5 ] : http://mces.blogspot.com/2009/11/pango-vs-harfbuzz.html
102116[ 6 ] : http://behdad.org/text2024
103- [ 7 ] : https://goo.gl/FSIQuC
104- [ 8 ] : https://goo.gl/2wSRu
117+ [ 7 ] : https://docs.google.com/presentation/d/1x97pfbB1gbD53Yhz6-_yBUozQMVJ_5yMqqR_D-R7b7I/preview
118+ [ 8 ] : https://docs.google.com/presentation/d/1ySTZaXP5XKFg0OpmHZM00v5b17GSr3ojnzJekl4U8qI/preview
105119[ 9 ] : http://behdad.org/download/Presentations/slippy/harfbuzz_slides.pdf
106- [ 10 ] : https://goo.gl/woyty
120+ [ 10 ] : https://docs.google.com/document/d/12jfNpQJzeVIAxoUSpk7KziyINAa1msbGliyXqguS86M/preview
121+ [ 11 ] : https://behdad.org/
122+ [ 12 ] : https://docs.google.com/document/d/1_VgObf6Je0J8byMLsi7HCQHnKo2emGnx_ib_sHo-bt4/preview
123+ [ 13 ] : https://docs.google.com/document/d/1Y-u08l9YhObRVObETZt1k8f_5lQdOix9TRH3zEXaoAw/preview
124+ [ 14 ] : https://docs.google.com/document/d/1o-xvxCbgMe9JYFHLVnPjk01ZY_8Cj0vB9-KTI1d0nyk/preview
125+ [ 15 ] : https://docs.google.com/document/d/18hI56KJpvXtwWbc9QSaz9zzhJwIMnrJ-zkAaKS-W-8k/preview
126+ [ 16 ] : https://docs.google.com/document/d/1Xq3owVt61HVkJqbLFHl73il6pcTy6PdPJJ7bSouQiQw/preview
127+ [ 17 ] : https://docs.google.com/document/d/1wMPwVNBvsIriamcyBO5aNs7Cdr8lmbwLJ8GmZBAswF4/preview
0 commit comments