Add minimal README.md files to published crates.

This will put descriptions on the packages' crates.io pages.
This commit is contained in:
Dan Gohman
2018-02-21 19:52:54 -08:00
parent 8e6e976e68
commit c7655c4928
11 changed files with 23 additions and 2 deletions

View File

@@ -7,6 +7,7 @@ license = "Apache-2.0"
documentation = "https://cretonne.readthedocs.io/" documentation = "https://cretonne.readthedocs.io/"
repository = "https://github.com/stoklund/cretonne" repository = "https://github.com/stoklund/cretonne"
publish = false publish = false
readme = "README.md"
build = "build.rs" build = "build.rs"
[lib] [lib]

2
lib/cretonne/README.md Normal file
View File

@@ -0,0 +1,2 @@
This crate contains the core Cretonne code generator. It translates code from an
intermediate language into executable machine code.

View File

@@ -7,6 +7,7 @@ license = "Apache-2.0"
documentation = "https://cretonne.readthedocs.io/" documentation = "https://cretonne.readthedocs.io/"
repository = "https://github.com/stoklund/cretonne" repository = "https://github.com/stoklund/cretonne"
publish = false publish = false
readme = "README.md"
[lib] [lib]
name = "cton_frontend" name = "cton_frontend"

5
lib/frontend/README.md Normal file
View File

@@ -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.

View File

@@ -1,7 +1,7 @@
//! Cretonne IL builder library. //! Cretonne IL builder library.
//! //!
//! Provides a straightforward way to create a Cretonne IL function and fill it with instructions //! 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. //! 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 //! To get started, create an [`IlBuilder`](struct.ILBuilder.html) and pass it as an argument

View File

@@ -3,9 +3,10 @@ name = "cretonne-native"
version = "0.0.0" version = "0.0.0"
authors = ["The Cretonne Project Developers"] authors = ["The Cretonne Project Developers"]
publish = false publish = false
description = "Support for targetting the host with Cretonne" description = "Support for targeting the host with Cretonne"
repository = "https://github.com/stoklund/cretonne" repository = "https://github.com/stoklund/cretonne"
license = "Apache-2.0" license = "Apache-2.0"
readme = "README.md"
[lib] [lib]
name = "cton_native" name = "cton_native"

3
lib/native/README.md Normal file
View File

@@ -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.

View File

@@ -7,6 +7,7 @@ license = "Apache-2.0"
documentation = "https://cretonne.readthedocs.io/" documentation = "https://cretonne.readthedocs.io/"
repository = "https://github.com/stoklund/cretonne" repository = "https://github.com/stoklund/cretonne"
publish = false publish = false
readme = "README.md"
[lib] [lib]
name = "cton_reader" name = "cton_reader"

3
lib/reader/README.md Normal file
View File

@@ -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.

View File

@@ -6,6 +6,7 @@ publish = false
description = "Translator from WebAssembly to Cretonne IL" description = "Translator from WebAssembly to Cretonne IL"
repository = "https://github.com/stoklund/cretonne" repository = "https://github.com/stoklund/cretonne"
license = "Apache-2.0" license = "Apache-2.0"
readme = "README.md"
[lib] [lib]
name = "cton_wasm" name = "cton_wasm"

3
lib/wasm/README.md Normal file
View File

@@ -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.