Skip to content

Commit d7e3737

Browse files
atouchetatouchet
authored
Update Readmes (#272)
1 parent 2567408 commit d7e3737

4 files changed

Lines changed: 45 additions & 41 deletions

File tree

‎README.md‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66

77
Bindings to the HarfBuzz text shaping engine.
88

9-
## Vendored Harfbuzz Sources
9+
## Vendored HarfBuzz Sources
1010

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

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

2525
## FreeType Support
2626

27-
The `freetype` feature is enabled by default. If your system does not have FreeType
28-
or FreeType development packages, which is typically the case for Windows, you can
29-
either disable default features or enable the `freetype-sys/bundled` feature.
27+
The `freetype` feature is enabled by default. If your system does not have
28+
FreeType or FreeType development packages, which is typically the case for
29+
Windows, you can either disable default features or enable the
30+
`freetype-sys/bundled` feature.

‎harfbuzz-sys/README.md‎

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,33 +3,35 @@
33
# harfbuzz-sys
44

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

99
</div>
1010

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

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

1716
## Features
1817

19-
- `freetype` - Enables bindings to the FreeType font engine. (Enabled by default.)
20-
- `coretext` - Enables bindings to the CoreText font engine. (Apple platforms only) (Enabled by default.)
21-
- `directwrite` - Enables bindings to the DirectWrite font engine. (Windows only) (Enabled by default.)
22-
23-
- `bundled` - Use the bundled copy of the harfbuzz library rather than one installed on the system.
18+
- `freetype` - Enables bindings to the FreeType font engine. (Enabled by
19+
default.)
20+
- `coretext` - Enables bindings to the Core Text font engine (Apple platforms
21+
only). (Enabled by default.)
22+
- `directwrite` - Enables bindings to the DirectWrite font engine (Windows
23+
only). (Enabled by default.)
24+
- `bundled` - Use the bundled copy of the HarfBuzz library rather than one
25+
installed on the system.
2426

2527
## License
2628

2729
Licensed under either of
2830

29-
- Apache License, Version 2.0
30-
([LICENSE-APACHE](LICENSE-APACHE) or <https://www.apache.org/licenses/LICENSE-2.0>)
31-
- MIT license
32-
([LICENSE-MIT](LICENSE-MIT) or <https://opensource.org/licenses/MIT>)
31+
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
32+
<https://www.apache.org/licenses/LICENSE-2.0>)
33+
- MIT license ([LICENSE-MIT](LICENSE-MIT) or
34+
<https://opensource.org/license/mit>)
3335

3436
at your option.
3537

‎harfbuzz-traits/README.md‎

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,13 @@
33
# harfbuzz-traits
44

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

99
</div>
1010

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

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

2019
Licensed under either of
2120

22-
- Apache License, Version 2.0
23-
([LICENSE-APACHE](LICENSE-APACHE) or <https://www.apache.org/licenses/LICENSE-2.0>)
24-
- MIT license
25-
([LICENSE-MIT](LICENSE-MIT) or <https://opensource.org/licenses/MIT>)
21+
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
22+
<https://www.apache.org/licenses/LICENSE-2.0>)
23+
- MIT license ([LICENSE-MIT](LICENSE-MIT) or
24+
<https://opensource.org/license/mit>)
2625

2726
at your option.
2827

‎harfbuzz/README.md‎

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,34 +3,36 @@
33
# harfbuzz
44

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

99
</div>
1010

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

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

1817
## Features
1918

20-
- `freetype` - Enables bindings to the FreeType font engine. (Enabled by default.)
21-
- `coretext` - Enables bindings to the CoreText font engine. (Apple platforms only) (Enabled by default.)
22-
- `directwrite` - Enables bindings to the DirectWrite font engine. (Windows only) (Enabled by default.)
23-
24-
- `bundled` - Use the bundled copy of the harfbuzz library rather than one installed on the system.
19+
- `freetype` - Enables bindings to the FreeType font engine. (Enabled by
20+
default.)
21+
- `coretext` - Enables bindings to the Core Text font engine (Apple platforms
22+
only). (Enabled by default.)
23+
- `directwrite` - Enables bindings to the DirectWrite font engine (Windows
24+
only). (Enabled by default.)
25+
- `bundled` - Use the bundled copy of the HarfBuzz library rather than one
26+
installed on the system.
2527

2628
## License
2729

2830
Licensed under either of
2931

30-
- Apache License, Version 2.0
31-
([LICENSE-APACHE](LICENSE-APACHE) or <https://www.apache.org/licenses/LICENSE-2.0>)
32-
- MIT license
33-
([LICENSE-MIT](LICENSE-MIT) or <https://opensource.org/licenses/MIT>)
32+
- Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or
33+
<https://www.apache.org/licenses/LICENSE-2.0>)
34+
- MIT license ([LICENSE-MIT](LICENSE-MIT) or
35+
<https://opensource.org/license/mit>)
3436

3537
at your option.
3638

0 commit comments

Comments
 (0)