Skip to content

Update Readmes #272

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Manishearth merged 1 commit into from
Sep 11, 2025
Merged

Update Readmes #272

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,11 @@

Bindings to the HarfBuzz text shaping engine.

## Vendored Harfbuzz Sources
## Vendored HarfBuzz Sources

This repository contains a vendored copy of the `harfbuzz` sources
as a git submodule. If building with the `bundled` feature, be sure
to initialize submodules:
This repository contains a vendored copy of the `harfbuzz` sources as a Git
submodule. If building with the `bundled` feature, be sure to initialize
submodules:

```
git clone --recursive https://github.com/servo/rust-harfbuzz.git
Expand All @@ -24,6 +24,7 @@ git submodule update --init

## FreeType Support

The `freetype` feature is enabled by default. If your system does not have FreeType
or FreeType development packages, which is typically the case for Windows, you can
either disable default features or enable the `freetype-sys/bundled` feature.
The `freetype` feature is enabled by default. If your system does not have
FreeType or FreeType development packages, which is typically the case for
Windows, you can either disable default features or enable the
`freetype-sys/bundled` feature.
28 changes: 15 additions & 13 deletions harfbuzz-sys/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,33 +3,35 @@
# harfbuzz-sys

[![Build Status](https://github.com/servo/rust-harfbuzz/actions/workflows/main.yml/badge.svg)](https://github.com/servo/rust-harfbuzz/actions)
[![Crates.io](https://img.shields.io/crates/v/harfbuzz-sys.svg)](https://crates.io/crates/harfbuzz-sys)
[![crates.io](https://img.shields.io/crates/v/harfbuzz-sys.svg)](https://crates.io/crates/harfbuzz-sys)
[![Docs](https://docs.rs/harfbuzz-sys/badge.svg)](https://docs.rs/harfbuzz-sys)

</div>

[HarfBuzz](https://harfbuzz.github.io/) is a text shaping engine. It
solves the problem of selecting and positioning glyphs from a font
given a Unicode string.
[HarfBuzz](https://harfbuzz.github.io/) is a text shaping engine. It solves the
problem of selecting and positioning glyphs from a font given a Unicode string.

This crate provides low-level bindings to the C API.

## Features

- `freetype` - Enables bindings to the FreeType font engine. (Enabled by default.)
- `coretext` - Enables bindings to the CoreText font engine. (Apple platforms only) (Enabled by default.)
- `directwrite` - Enables bindings to the DirectWrite font engine. (Windows only) (Enabled by default.)

- `bundled` - Use the bundled copy of the harfbuzz library rather than one installed on the system.
- `freetype` - Enables bindings to the FreeType font engine. (Enabled by
default.)
- `coretext` - Enables bindings to the Core Text font engine (Apple platforms
only). (Enabled by default.)
- `directwrite` - Enables bindings to the DirectWrite font engine (Windows
only). (Enabled by default.)
- `bundled` - Use the bundled copy of the HarfBuzz library rather than one
installed on the system.

## License

Licensed under either of

- Apache License, Version 2.0
([LICENSE-APACHE](LICENSE-APACHE) or <https://www.apache.org/licenses/LICENSE-2.0>)
- MIT license
([LICENSE-MIT](LICENSE-MIT) or <https://opensource.org/licenses/MIT>)
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
<https://www.apache.org/licenses/LICENSE-2.0>)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or
<https://opensource.org/license/mit>)

at your option.

Expand Down
15 changes: 7 additions & 8 deletions harfbuzz-traits/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,13 @@
# harfbuzz-traits

[![Build Status](https://github.com/servo/rust-harfbuzz/actions/workflows/main.yml/badge.svg)](https://github.com/servo/rust-harfbuzz/actions)
[![Crates.io](https://img.shields.io/crates/v/harfbuzz-traits.svg)](https://crates.io/crates/harfbuzz-traits)
[![crates.io](https://img.shields.io/crates/v/harfbuzz-traits.svg)](https://crates.io/crates/harfbuzz-traits)
[![Docs](https://docs.rs/harfbuzz-traits/badge.svg)](https://docs.rs/harfbuzz-traits)

</div>

[HarfBuzz](https://harfbuzz.github.io/) is a text shaping engine. It
solves the problem of selecting and positioning glyphs from a font
given a Unicode string.
[HarfBuzz](https://harfbuzz.github.io/) is a text shaping engine. It solves the
problem of selecting and positioning glyphs from a font given a Unicode string.

This crate provides high-level Rust traits that can be implemented without
depending on HarfBuzz itself.
Expand All @@ -19,10 +18,10 @@ depending on HarfBuzz itself.

Licensed under either of

- Apache License, Version 2.0
([LICENSE-APACHE](LICENSE-APACHE) or <https://www.apache.org/licenses/LICENSE-2.0>)
- MIT license
([LICENSE-MIT](LICENSE-MIT) or <https://opensource.org/licenses/MIT>)
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
<https://www.apache.org/licenses/LICENSE-2.0>)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or
<https://opensource.org/license/mit>)

at your option.

Expand Down
28 changes: 15 additions & 13 deletions harfbuzz/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,34 +3,36 @@
# harfbuzz

[![Build Status](https://github.com/servo/rust-harfbuzz/actions/workflows/main.yml/badge.svg)](https://github.com/servo/rust-harfbuzz/actions)
[![Crates.io](https://img.shields.io/crates/v/harfbuzz.svg)](https://crates.io/crates/harfbuzz)
[![crates.io](https://img.shields.io/crates/v/harfbuzz.svg)](https://crates.io/crates/harfbuzz)
[![Docs](https://docs.rs/harfbuzz/badge.svg)](https://docs.rs/harfbuzz)

</div>

[HarfBuzz](https://harfbuzz.github.io/) is a text shaping engine. It
solves the problem of selecting and positioning glyphs from a font
given a Unicode string.
[HarfBuzz](https://harfbuzz.github.io/) is a text shaping engine. It solves the
problem of selecting and positioning glyphs from a font given a Unicode string.

This crate provides a higher level API (than the
[raw C bindings](https://crates.io/crates/harfbuzz-sys)).

## Features

- `freetype` - Enables bindings to the FreeType font engine. (Enabled by default.)
- `coretext` - Enables bindings to the CoreText font engine. (Apple platforms only) (Enabled by default.)
- `directwrite` - Enables bindings to the DirectWrite font engine. (Windows only) (Enabled by default.)

- `bundled` - Use the bundled copy of the harfbuzz library rather than one installed on the system.
- `freetype` - Enables bindings to the FreeType font engine. (Enabled by
default.)
- `coretext` - Enables bindings to the Core Text font engine (Apple platforms
only). (Enabled by default.)
- `directwrite` - Enables bindings to the DirectWrite font engine (Windows
only). (Enabled by default.)
- `bundled` - Use the bundled copy of the HarfBuzz library rather than one
installed on the system.

## License

Licensed under either of

- Apache License, Version 2.0
([LICENSE-APACHE](LICENSE-APACHE) or <https://www.apache.org/licenses/LICENSE-2.0>)
- MIT license
([LICENSE-MIT](LICENSE-MIT) or <https://opensource.org/licenses/MIT>)
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
<https://www.apache.org/licenses/LICENSE-2.0>)
- MIT license ([LICENSE-MIT](LICENSE-MIT) or
<https://opensource.org/license/mit>)

at your option.

Expand Down
Loading