From: Behnam Esfahbod Date: Thu, 31 Aug 2017 08:04:54 +0000 (-0700) Subject: [src/doc/book] Add introduction page X-Git-Tag: archive/raspbian/0.35.0-2+rpi1~3^2^2^2^2^2^2^2~22^2~6^2~70^2~6 X-Git-Url: https://dgit.raspbian.org/?a=commitdiff_plain;h=63f37e3f179f585e2c2fe79f954ab9dea3b12f31;p=cargo.git [src/doc/book] Add introduction page --- diff --git a/src/doc/book/src/01-02-first-steps.md b/src/doc/book/src/01-02-first-steps.md index 25d36f96b..097f3455d 100644 --- a/src/doc/book/src/01-02-first-steps.md +++ b/src/doc/book/src/01-02-first-steps.md @@ -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) diff --git a/src/doc/book/src/SUMMARY.md b/src/doc/book/src/SUMMARY.md index 21e8c151c..ab4028d2f 100644 --- a/src/doc/book/src/SUMMARY.md +++ b/src/doc/book/src/SUMMARY.md @@ -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) diff --git a/src/doc/book/src/cargo-in-depth.md b/src/doc/book/src/cargo-in-depth.md index e73c9cdbf..b367ccba3 100644 --- a/src/doc/book/src/cargo-in-depth.md +++ b/src/doc/book/src/cargo-in-depth.md @@ -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) diff --git a/src/doc/book/src/getting-started.md b/src/doc/book/src/getting-started.md index 7865c4e94..89c69a755 100644 --- a/src/doc/book/src/getting-started.md +++ b/src/doc/book/src/getting-started.md @@ -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) diff --git a/src/doc/book/src/guide.md b/src/doc/book/src/guide.md index 704f87b8a..7e8ecaedb 100644 --- a/src/doc/book/src/guide.md +++ b/src/doc/book/src/guide.md @@ -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 index 000000000..850ede20e --- /dev/null +++ b/src/doc/book/src/introduction.md @@ -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/