diff --git a/README.md b/README.md index e622b317..6f19b8c0 100644 --- a/README.md +++ b/README.md @@ -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 @@ -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. diff --git a/harfbuzz-sys/README.md b/harfbuzz-sys/README.md index 7f10eee1..d08a6c19 100644 --- a/harfbuzz-sys/README.md +++ b/harfbuzz-sys/README.md @@ -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) -[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 ) -- MIT license - ([LICENSE-MIT](LICENSE-MIT) or ) +- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or + ) +- MIT license ([LICENSE-MIT](LICENSE-MIT) or + ) at your option. diff --git a/harfbuzz-traits/README.md b/harfbuzz-traits/README.md index 90a5c9f6..33554245 100644 --- a/harfbuzz-traits/README.md +++ b/harfbuzz-traits/README.md @@ -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) -[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. @@ -19,10 +18,10 @@ depending on HarfBuzz itself. Licensed under either of -- Apache License, Version 2.0 - ([LICENSE-APACHE](LICENSE-APACHE) or ) -- MIT license - ([LICENSE-MIT](LICENSE-MIT) or ) +- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or + ) +- MIT license ([LICENSE-MIT](LICENSE-MIT) or + ) at your option. diff --git a/harfbuzz/README.md b/harfbuzz/README.md index 7b1ae1ec..c1e2a7d6 100644 --- a/harfbuzz/README.md +++ b/harfbuzz/README.md @@ -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) -[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 ) -- MIT license - ([LICENSE-MIT](LICENSE-MIT) or ) +- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or + ) +- MIT license ([LICENSE-MIT](LICENSE-MIT) or + ) at your option.