README.md
1This is a library for managing targets for compilers and related tools.
2
3Currently, the main feature is support for decoding "triples", which
4are strings that identify a particular target configuration. They're named
5"triples" because historically they contained three fields, though over time
6they've added additional fields. This library provides a `Triple` struct
7containing enums for each of fields of a triple. `Triple` implements
8`FromStr` and `fmt::Display` so it can be converted to and from the
9conventional string representation of a triple.
10
11`Triple` also has functions for querying a triple's endianness,
12pointer bit width, and binary format.
13
14And, `Triple` and the enum types have `host()` constructors, for targeting
15the host.
16
17It supports all triples currently used by rustc and rustup.
18
19It does not support reading JSON target files itself. To use it with a JSON
20target file, construct a `Triple` using the value of the "llvm-target" field.
21