Skip to content

Commit

Permalink
Update README and cargo metadata
Browse files Browse the repository at this point in the history
  • Loading branch information
wezm committed Dec 5, 2019
1 parent 7710b52 commit 67ee0d0
Show file tree
Hide file tree
Showing 3 changed files with 32 additions and 6 deletions.
28 changes: 24 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,21 +20,21 @@ fontconfig-rs
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.

Dependencies
============
------------

* Arch Linux: `fontconfig`
* Debian-based systems: `libfontconfig1-dev`
* FreeBSD: `fontconfig`
* Void Linux: `fontconfig-devel`

Usage
=====
-----

Cargo.toml:

```toml
[dependencies]
fontconfig = "0.1.0"
yeslogic-fontconfig = "0.1.0"
```

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

[gl]: https://github.com/PistonDevelopers/opengl_graphics
Other Fontconfig Crates
-----------------------

* [servo-fontconfig] — This crate provides a low-level interface only.
It depends on [servo-fontconfig-sys], which will fall back to
building a vendored version of Fontconfig if a compatible version can't be found. It in turn depends on
[expat-sys], which does the same thing regarding a vendored version of
Expat. This makes it easier if you are distributing a code base that needs Fontconfig but provides less control
over the libraries that will be used.
* [fontconfig] + [fontconfig-sys] — These crates have not been updated since Dec 2014.

For our needs in [Prince] we wanted higher-level bindings that did not fall back on vendored
versions of libraries, which is what the crates in this repo provide.

[conrod]: https://github.com/PistonDevelopers/conrod
[expat-sys]: https://crates.io/crates/expat-sys
[fontconfig-sys]: https://crates.io/crates/fontconfig-sys
[fontconfig]: https://crates.io/crates/fontconfig
[gl]: https://github.com/PistonDevelopers/opengl_graphics
[homepage]: https://www.freedesktop.org/wiki/Software/fontconfig/
[Prince]: https://www.princexml.com/
[servo-fontconfig-sys]: https://crates.io/crates/servo-fontconfig-sys
[servo-fontconfig]: https://crates.io/crates/servo-fontconfig
5 changes: 4 additions & 1 deletion fontconfig-sys/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ authors = [
]
license = "MIT"

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

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

[badges]
travis-ci = { repository = "yeslogic/fontconfig-rs" }

[lib]
name = "fontconfig_sys"

Expand Down
5 changes: 4 additions & 1 deletion fontconfig/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -9,14 +9,17 @@ authors = [
license = "MIT"
readme = "README.md"

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

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

[badges]
travis-ci = { repository = "yeslogic/fontconfig-rs" }

[lib]
name = "fontconfig"

Expand Down

0 comments on commit 67ee0d0

Please sign in to comment.