Add README for qttypes

Author: ogoffart

qmetaobject/Cargo.toml

@@ -7,6 +7,7 @@ build = "build.rs"
 description = "Expose rust object to Qt and QML."
 readme = "../README.md"
 license = "MIT"
+categories = ["api-bindings", "gui"]
 keywords = ["Qt", "QML", "QMetaObject",]
 repository = "https://github.com/woboq/qmetaobject-rs"
 

qttypes/Cargo.toml

@@ -7,6 +7,7 @@ build = "build.rs"
 description = "Manually maintained buildings for Qt value types"
 readme = "README.md"
 license = "MIT"
+categories = ["api-bindings", "ffi"]
 keywords = ["Qt", "QtCore", "QtGui"]
 repository = "https://github.com/woboq/qmetaobject-rs"
 links = "qt"

qttypes/README.md

@@ -0,0 +1,16 @@
+# qttypes
+
+This crate contains manually generated bindings to Qt basic value types.
+It is meant to be used by other crates, such as the `qmetaobject` crate which re-expose them
+
+The Qt types are basically exposed using the `cpp` crate. They have manually writen rust idiomatic
+API which expose the C++ API.
+These types are the direct equivalent of the Qt types and are exposed on the stack.
+
+In addition, the build script of this crate expose some metadata to downstream crate that also
+want to use Qt's C++ API:
+ - `DEP_QT_VERSION`: The Qt version as given by qmake
+ - `DEP_QT_INCLUDE_PATH`: The include directory to give to the `cpp_build` crate to locate the Qt headers
+ - `DEP_QT_LIBRARY_PATH`: The path containing the Qt libraries.
+
+See the [crate documentation](https://docs.rs/qttypes) for more info.

qttypes/src/lib.rs

@@ -22,9 +22,10 @@ CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 //! API which expose the C++ API.
 //! These types are the direct equivalent of the Qt types and are exposed on the stack.
 //!
-//! In addition, the build script of this crate expose some metadata that are usefull to build.
+//! In addition, the build script of this crate expose some metadata to downstream crate that also
+//! want to use Qt's C++ API.
 //! Build scripts of crates that depends directly from this crate will have the following
-//! environment variable when the build script is run:
+//! environment variables set when the build script is run:
 //! - `DEP_QT_VERSION`: The Qt version as given by qmake
 //! - `DEP_QT_INCLUDE_PATH`: The include directory to give to the `cpp_build` crate to locate the Qt headers
 //! - `DEP_QT_LIBRARY_PATH`: The path containing the Qt libraries.