]> git.proxmox.com Git - cargo.git/commitdiff
[src/doc/book] Add introduction page
authorBehnam Esfahbod <behnam@zwnj.org>
Thu, 31 Aug 2017 08:04:54 +0000 (01:04 -0700)
committerBehnam Esfahbod <behnam@zwnj.org>
Thu, 31 Aug 2017 21:49:30 +0000 (14:49 -0700)
src/doc/book/src/01-02-first-steps.md
src/doc/book/src/SUMMARY.md
src/doc/book/src/cargo-in-depth.md
src/doc/book/src/getting-started.md
src/doc/book/src/guide.md
src/doc/book/src/introduction.md [new file with mode: 0644]

index 25d36f96b93953fc17d14b8428bf881c428713d4..097f3455d4540fd670332b1a5a81c6ede162ad24 100644 (file)
@@ -65,6 +65,6 @@ $ cargo run
 Hello, world!
 ```
 
-## Going further
+### Going further
 
 For more details on using Cargo, check out the [Cargo Guide](guide.html)
index 21e8c151c138af1c9a8abaf4bbd2c9cf41a444e4..ab4028d2ff20316317b0dff722d16e1edb1b194e 100644 (file)
@@ -1,5 +1,7 @@
 # Summary
 
+[Introduction](introduction.md)
+
 * [Getting Started](getting-started.md)
     * [Installation](01-01-installation.md)
     * [First Steps with Cargo](01-02-first-steps.md)
@@ -26,4 +28,4 @@
     * [External Tools](03-09-external-tools.md)
     * [Policies](03-10-policies.md)
 
-[FAQ](faq.md)
+[FAQ](faq.md)
index e73c9cdbf10ee1ac260d34a9e9ea997c843e77fc..b367ccba3dd23b512870c2bfd77c163c5185084e 100644 (file)
@@ -1,17 +1,14 @@
 ## Cargo In Depth
 
-Now that you have an overview of how to use cargo and have created your first
-crate, you may be interested in:
+Now that you have an overview of how to use Cargo and have created your first
+crate, you may be interested in more details in the following areas.
 
-* [Publishing your crate on crates.io](03-06-crates-io.html)
 * [Reading about all the possible ways of specifying dependencies](03-01-specifying-dependencies.html)
 * [Learning more details about what you can specify in your `Cargo.toml` manifest](03-02-manifest.html)
-* [Specifying Dependencies](03-01-specifying-dependencies.html)
-* [Cargo.toml Format](03-02-manifest.html)
 * [Configuration](03-03-config.html)
 * [Environment Variables](03-04-environment-variables.html)
 * [Build Scripts](03-05-build-scripts.html)
-* [Publishing on crates.io](03-06-crates-io.html)
+* [Publishing your crate on crates.io](03-06-crates-io.html)
 * [Package ID specs](03-07-pkgid-spec.html)
 * [Source Replacement](03-08-source-replacement.html)
 * [External Tools](03-09-external-tools.html)
index 7865c4e9496eb3a7af0880fbc3ca5aa153d843b0..89c69a755fcf1f3df824e54aefa8eebef1e4be7b 100644 (file)
@@ -1,4 +1,6 @@
 ## Getting Started
 
+To get started with Cargo, install Cargo (and Rust) and set up your first crate.
+
 * [Installation](01-01-installation.html)
 * [First steps with Cargo](01-02-first-steps.html)
index 704f87b8acfad07b0763b48e17e05199c2126a21..7e8ecaedbd8dfa97aa093a2ccc002f41758a403b 100644 (file)
@@ -1,13 +1,13 @@
 ## Cargo Guide
 
-Welcome to the Cargo guide. This guide will give you all that you need to know
-about how to use Cargo to develop Rust projects.
+This guide will give you all that you need to know about how to use Cargo to
+develop Rust projects.
 
-* [Why Cargo exists](02-01-why-cargo-exists.html)
-* [Creating a new project](02-02-creating-a-new-project.html)
-* [Working on an existing Cargo project](02-03-working-on-an-existing-project.html)
+* [Why Cargo Exists](02-01-why-cargo-exists.html)
+* [Creating a New Project](02-02-creating-a-new-project.html)
+* [Working on an Existing Cargo Project](02-03-working-on-an-existing-project.html)
 * [Dependencies](02-04-dependencies.html)
-* [Project layout](02-05-project-layout.html)
+* [Project Layout](02-05-project-layout.html)
 * [Cargo.toml vs Cargo.lock](02-06-cargo-toml-vs-cargo-lock.html)
 * [Tests](02-07-tests.html)
 * [Continuous Integration](02-08-continuous-integration.html)
diff --git a/src/doc/book/src/introduction.md b/src/doc/book/src/introduction.md
new file mode 100644 (file)
index 0000000..850ede2
--- /dev/null
@@ -0,0 +1,51 @@
+# The Cargo Manual
+
+![Cargo Logo](images/Cargo-Logo-Small.png)
+
+Cargo is the [Rust] *package manager*. Cargo downloads your Rust project’s
+dependencies, compiles your project, makes packages, and upload them to
+[crates.io], the Rust *package registry*.
+
+
+## [Getting Started](getting-started.html)
+
+To get started with Cargo, install Cargo (and Rust) and set up your first crate.
+
+* [Installation](01-01-installation.html)
+* [First Steps with Cargo](01-02-first-steps.html)
+
+## [Cargo Guide](guide.html)
+
+The guide will give you all you need to know about how to use Cargo to develop
+Rust projects.
+
+* [Why Cargo exists](02-01-why-cargo-exists.html)
+* [Creating a new project](02-02-creating-a-new-project.html)
+* [Working on an existing Cargo
+    project](02-03-working-on-an-existing-project.html)
+* [Dependencies](02-04-dependencies.html)
+* [Project layout](02-05-project-layout.html)
+* [Cargo.toml vs Cargo.lock](02-06-cargo-toml-vs-cargo-lock.html)
+* [Tests](02-07-tests.html)
+* [Continuous Integration](02-08-continuous-integration.html)
+
+## [Cargo In Depth](cargo-in-depth.html)
+
+After having an overview of how to use Cargo and have created your first crate,
+you may be interested in more details in the following areas.
+
+* [Specifying Dependencies](03-01-specifying-dependencies.html)
+* [Cargo.toml Format](03-02-manifest.html)
+* [Configuration](03-03-config.html)
+* [Environment Variables](03-04-environment-variables.html)
+* [Build Scripts](03-05-build-scripts.html)
+* [Publishing on crates.io](03-06-crates-io.html)
+* [Package ID specs](03-07-pkgid-spec.html)
+* [Source Replacement](03-08-source-replacement.html)
+* [External Tools](03-09-external-tools.html)
+* [Policies](03-10-policies.html)
+
+## [Frequently Asked Questions](faq.html)
+
+[rust]: https://www.rust-lang.org/
+[crates.io]: https://crates.io/