Move quickstart to examples/.

Author: Yamakaky

README.md

@@ -19,55 +19,7 @@ provides a few unique features:
 
 ## Quick start
 
-Add this to Cargo.toml, under `[dependencies]`:
-
-```toml
-error-chain = "0.6"
-```
-
-Write this at the top of your crate:
-
-```rust
-#![recursion_limit = "1024"]
-```
-
-Again near the top of your crate, import the `error_chain` crate and its macros:
-
-```rust
-#[macro_use]
-extern crate error_chain;
-```
-
-Add an `errors` module to your crate:
-
-```rust
-mod errors;
-```
-
-Add a file for that module called `errors.rs` and put this inside:
-
-```rust
-error_chain! { }
-```
-
-That's the setup. Now when writing modules for your crate,
-import everything from the `errors` module:
-
-```rust
-use errors::*;
-```
-
-Create functions that return `Result`, which is defined by
-the `error_chain!` macro, and start chaining errors!
-
-```rust
-fn do_error_prone_work() -> Result<()> {
-    let file = try!(File::open("foo").chain_err(|| "couldn't open file"));
-    try!(file.write_all("important".as_bytes()).chain_err(|| "couldn't write file"));
-
-    Ok(())
-}
-```
+See https://github.com/brson/error-chain/blob/master/examples/quickstart.rs.
 
 ## License
 

examples/quickstart.rs

@@ -0,0 +1,41 @@
+// This macro use recursion a lot.
+#![recursion_limit = "1024"]
+
+// Import of the macro. Don't forget to add `error-chain = "*"` in your
+// `Cargo.toml`!
+#[macro_use]
+extern crate error_chain;
+
+// Generations of the `Error` type, the `ErrorKind` enum and the `Result`
+// wrapper. See the documentation for more details.
+//
+// You can also generate the types in a dedicated modules, like `errors.rs`.
+error_chain! {
+    foreign_links {
+        // An IO error can occur.
+        Io(::std::io::Error);
+    }
+}
+
+// With the `Result` wrapper, we don't have to specify `Error` each time.
+fn do_some_work() -> Result<()> {
+    use std::fs::File;
+    // Dummy file, this operation should fail on your system. The result of
+    // `File::open` is automatically converted to our `Error` type.
+    File::open("tretrete")?;
+    Ok(())
+}
+
+fn main() {
+    match do_some_work() {
+        Ok(()) => println!("No errors"),
+        Err(e) => {
+            println!("An error occured: {}", e);
+            // The backtrace is not always generated. Try to run this example
+            // with `RUST_BACKTRACE=1`.
+            if let Some(backtrace) = e.backtrace() {
+                println!("Backtrace: {:?}", backtrace);
+            }
+        }
+    }
+}

src/lib.rs

@@ -58,65 +58,7 @@
 //!
 //! ## Quick start
 //!
-//! Add this to Cargo.toml, under `[dependencies]`:
-//!
-//! ```toml
-//! error-chain = "0.5"
-//! ```
-//!
-//! Write this at the top of your crate:
-//!
-//! ```
-//! #![recursion_limit = "1024"]
-//! # fn main() {}
-//! ```
-//!
-//! Again near the top of your crate, import the `error_chain` crate and its macros:
-//!
-//! ```
-//! #[macro_use]
-//! extern crate error_chain;
-//! # fn main() {}
-//! ```
-//!
-//! Add an `errors` module to your crate:
-//!
-//! ```ignore
-//! mod errors;
-//! ```
-//!
-//! Add a file for that module called `errors.rs` and put this inside:
-//!
-//! ```
-//! # #[macro_use] extern crate error_chain;
-//! # fn main() {}
-//! error_chain! { }
-//! ```
-//!
-//! That's the setup. Now when writing modules for your crate,
-//! import everything from the `errors` module:
-//!
-//! ```ignore
-//! use errors::*;
-//! ```
-//!
-//! Create functions that return `Result`, which is defined by
-//! the `error_chain!` macro, and start chaining errors!
-//!
-//! ```ignore
-//! # #[macro_use] extern crate error_chain;
-//! # use std::fs::File;
-//! # use std::io::Write;
-//! # use error_chain::ResultExt;
-//! # fn main() {}
-//! # error_chain! {}
-//! fn do_error_prone_work() -> Result<()> {
-//!     let file = try!(File::open("foo").chain_err(|| "couldn't open file"));
-//!     try!(file.write_all("important".as_bytes()).chain_err(|| "couldn't write file"));
-//!
-//!     Ok(())
-//! }
-//! ```
+//! See https://github.com/brson/error-chain/blob/master/examples/quickstart.rs.
 //!
 //! ## Declaring error types
 //!