Skip to content

Commit 67ee0d0

Browse files
committed
Update README and cargo metadata
1 parent 7710b52 commit 67ee0d0

File tree

3 files changed

+32
-6
lines changed

3 files changed

+32
-6
lines changed

README.md

+24-4
Original file line numberDiff line numberDiff line change
@@ -20,21 +20,21 @@ fontconfig-rs
2020
A wrapper around [freedesktop.org's fontconfig library][homepage], for locating fonts on a UNIX like systems such as Linux and FreeBSD. Requires fontconfig to be installed.
2121

2222
Dependencies
23-
============
23+
------------
2424

2525
* Arch Linux: `fontconfig`
2626
* Debian-based systems: `libfontconfig1-dev`
2727
* FreeBSD: `fontconfig`
2828
* Void Linux: `fontconfig-devel`
2929

3030
Usage
31-
=====
31+
-----
3232

3333
Cargo.toml:
3434

3535
```toml
3636
[dependencies]
37-
fontconfig = "0.1.0"
37+
yeslogic-fontconfig = "0.1.0"
3838
```
3939

4040
main.rs:
@@ -55,6 +55,26 @@ fn main() {
5555
You could then, for example, use `font.path` to create a `GlyphCache` from [`opengl_graphics`][gl]
5656
and pass it to [`conrod`][conrod].
5757

58-
[gl]: https://github.com/PistonDevelopers/opengl_graphics
58+
Other Fontconfig Crates
59+
-----------------------
60+
61+
* [servo-fontconfig] — This crate provides a low-level interface only.
62+
It depends on [servo-fontconfig-sys], which will fall back to
63+
building a vendored version of Fontconfig if a compatible version can't be found. It in turn depends on
64+
[expat-sys], which does the same thing regarding a vendored version of
65+
Expat. This makes it easier if you are distributing a code base that needs Fontconfig but provides less control
66+
over the libraries that will be used.
67+
* [fontconfig] + [fontconfig-sys] — These crates have not been updated since Dec 2014.
68+
69+
For our needs in [Prince] we wanted higher-level bindings that did not fall back on vendored
70+
versions of libraries, which is what the crates in this repo provide.
71+
5972
[conrod]: https://github.com/PistonDevelopers/conrod
73+
[expat-sys]: https://crates.io/crates/expat-sys
74+
[fontconfig-sys]: https://crates.io/crates/fontconfig-sys
75+
[fontconfig]: https://crates.io/crates/fontconfig
76+
[gl]: https://github.com/PistonDevelopers/opengl_graphics
6077
[homepage]: https://www.freedesktop.org/wiki/Software/fontconfig/
78+
[Prince]: https://www.princexml.com/
79+
[servo-fontconfig-sys]: https://crates.io/crates/servo-fontconfig-sys
80+
[servo-fontconfig]: https://crates.io/crates/servo-fontconfig

fontconfig-sys/Cargo.toml

+4-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ authors = [
88
]
99
license = "MIT"
1010

11-
description = "Raw bindings to the fontconfig library"
11+
description = "Raw bindings to Fontconfig without a vendored C library"
1212
keywords = ["font", "bindings", "fontconfig", "sys"]
1313
categories = ["text-processing"]
1414

@@ -19,6 +19,9 @@ repository = "https://github.com/yeslogic/fontconfig-rs"
1919
build = "build.rs"
2020
links = "fontconfig"
2121

22+
[badges]
23+
travis-ci = { repository = "yeslogic/fontconfig-rs" }
24+
2225
[lib]
2326
name = "fontconfig_sys"
2427

fontconfig/Cargo.toml

+4-1
Original file line numberDiff line numberDiff line change
@@ -9,14 +9,17 @@ authors = [
99
license = "MIT"
1010
readme = "README.md"
1111

12-
description = "Safe wrapper around the fontconfig library"
12+
description = "Safe, higher-level wrapper around the Fontconfig library"
1313
keywords = ["font", "search", "wrapper", "fontconfig"]
1414
categories = ["text-processing"]
1515

1616
homepage = "https://github.com/yeslogic/fontconfig-rs"
1717
documentation = "https://docs.rs/crate/yeslogic-fontconfig"
1818
repository = "https://github.com/yeslogic/fontconfig-rs"
1919

20+
[badges]
21+
travis-ci = { repository = "yeslogic/fontconfig-rs" }
22+
2023
[lib]
2124
name = "fontconfig"
2225

0 commit comments

Comments
 (0)