From c7655c4928324994973d780c8065ecb861f5ed83 Mon Sep 17 00:00:00 2001
From: Dan Gohman <sunfish@mozilla.com>
Date: Wed, 21 Feb 2018 19:52:54 -0800
Subject: [PATCH] Add minimal README.md files to published crates.

This will put descriptions on the packages' crates.io pages.
---
 lib/cretonne/Cargo.toml | 1 +
 lib/cretonne/README.md  | 2 ++
 lib/frontend/Cargo.toml | 1 +
 lib/frontend/README.md  | 5 +++++
 lib/frontend/src/lib.rs | 2 +-
 lib/native/Cargo.toml   | 3 ++-
 lib/native/README.md    | 3 +++
 lib/reader/Cargo.toml   | 1 +
 lib/reader/README.md    | 3 +++
 lib/wasm/Cargo.toml     | 1 +
 lib/wasm/README.md      | 3 +++
 11 files changed, 23 insertions(+), 2 deletions(-)
 create mode 100644 lib/cretonne/README.md
 create mode 100644 lib/frontend/README.md
 create mode 100644 lib/native/README.md
 create mode 100644 lib/reader/README.md
 create mode 100644 lib/wasm/README.md

diff --git a/lib/cretonne/Cargo.toml b/lib/cretonne/Cargo.toml
index 60e8eb2be9..e85779913c 100644
--- a/lib/cretonne/Cargo.toml
+++ b/lib/cretonne/Cargo.toml
@@ -7,6 +7,7 @@ license = "Apache-2.0"
 documentation = "https://cretonne.readthedocs.io/"
 repository = "https://github.com/stoklund/cretonne"
 publish = false
+readme = "README.md"
 build = "build.rs"
 
 [lib]
diff --git a/lib/cretonne/README.md b/lib/cretonne/README.md
new file mode 100644
index 0000000000..73b2806f5d
--- /dev/null
+++ b/lib/cretonne/README.md
@@ -0,0 +1,2 @@
+This crate contains the core Cretonne code generator. It translates code from an
+intermediate language into executable machine code.
diff --git a/lib/frontend/Cargo.toml b/lib/frontend/Cargo.toml
index 7ff44a1f6f..704517c176 100644
--- a/lib/frontend/Cargo.toml
+++ b/lib/frontend/Cargo.toml
@@ -7,6 +7,7 @@ license = "Apache-2.0"
 documentation = "https://cretonne.readthedocs.io/"
 repository = "https://github.com/stoklund/cretonne"
 publish = false
+readme = "README.md"
 
 [lib]
 name = "cton_frontend"
diff --git a/lib/frontend/README.md b/lib/frontend/README.md
new file mode 100644
index 0000000000..53248b68ab
--- /dev/null
+++ b/lib/frontend/README.md
@@ -0,0 +1,5 @@
+This crate provides a straightforward way to create a
+[Cretonne](https://crates.io/crates/cretonne) IL function and fill it with
+instructions translated from another language. It contains an SSA construction
+module that provides convenient methods for translating non-SSA variables into
+SSA Cretonne IL values via `use_var` and `def_var` calls.
diff --git a/lib/frontend/src/lib.rs b/lib/frontend/src/lib.rs
index 4307023ab9..9db5a4a34b 100644
--- a/lib/frontend/src/lib.rs
+++ b/lib/frontend/src/lib.rs
@@ -1,7 +1,7 @@
 //! Cretonne IL builder library.
 //!
 //! Provides a straightforward way to create a Cretonne IL function and fill it with instructions
-//! translated from another language. Contains a SSA construction module that lets you translate
+//! translated from another language. Contains an SSA construction module that lets you translate
 //! your non-SSA variables into SSA Cretonne IL values via `use_var` and `def_var` calls.
 //!
 //! To get started, create an [`IlBuilder`](struct.ILBuilder.html) and pass it as an argument
diff --git a/lib/native/Cargo.toml b/lib/native/Cargo.toml
index 0f66bc6037..c7389127c6 100644
--- a/lib/native/Cargo.toml
+++ b/lib/native/Cargo.toml
@@ -3,9 +3,10 @@ name = "cretonne-native"
 version = "0.0.0"
 authors = ["The Cretonne Project Developers"]
 publish = false
-description = "Support for targetting the host with Cretonne"
+description = "Support for targeting the host with Cretonne"
 repository = "https://github.com/stoklund/cretonne"
 license = "Apache-2.0"
+readme = "README.md"
 
 [lib]
 name = "cton_native"
diff --git a/lib/native/README.md b/lib/native/README.md
new file mode 100644
index 0000000000..2e91c82ab1
--- /dev/null
+++ b/lib/native/README.md
@@ -0,0 +1,3 @@
+This crate performs autodetection of the host architecture, which can be used to
+configure [Cretonne](https://crates.io/crates/cretonne) to generate code
+specialized for the machine it's running on.
diff --git a/lib/reader/Cargo.toml b/lib/reader/Cargo.toml
index 030d20ff9f..4ea993ab0c 100644
--- a/lib/reader/Cargo.toml
+++ b/lib/reader/Cargo.toml
@@ -7,6 +7,7 @@ license = "Apache-2.0"
 documentation = "https://cretonne.readthedocs.io/"
 repository = "https://github.com/stoklund/cretonne"
 publish = false
+readme = "README.md"
 
 [lib]
 name = "cton_reader"
diff --git a/lib/reader/README.md b/lib/reader/README.md
new file mode 100644
index 0000000000..8430d11919
--- /dev/null
+++ b/lib/reader/README.md
@@ -0,0 +1,3 @@
+This crate library supports reading .cton files. This functionality is needed
+for testing [Cretonne](https://crates.io/crates/cretonne), but is not essential
+for a JIT compiler.
diff --git a/lib/wasm/Cargo.toml b/lib/wasm/Cargo.toml
index 56d49d7cf6..7947348d98 100644
--- a/lib/wasm/Cargo.toml
+++ b/lib/wasm/Cargo.toml
@@ -6,6 +6,7 @@ publish = false
 description = "Translator from WebAssembly to Cretonne IL"
 repository = "https://github.com/stoklund/cretonne"
 license = "Apache-2.0"
+readme = "README.md"
 
 [lib]
 name = "cton_wasm"
diff --git a/lib/wasm/README.md b/lib/wasm/README.md
new file mode 100644
index 0000000000..f12f00d46a
--- /dev/null
+++ b/lib/wasm/README.md
@@ -0,0 +1,3 @@
+This crate performs the translation from a wasm module in binary format to the
+in-memory representation of the [Cretonne](https://crates.io/crates/cretonne)
+IL.