Rocket/site/guide/1-quickstart.md

33 lines
1.1 KiB
Markdown
Raw Normal View History

# Quickstart
Before you can start writing a Rocket application, you'll need a **nightly**
version of Rust installed. We recommend you use [rustup](https://rustup.rs/) to
2017-07-10 11:59:55 +00:00
install or configure such a version. If you don't have Rust installed and would
2018-10-16 05:50:35 +00:00
like extra guidance doing so, see the [getting started](../getting-started)
2017-07-10 11:59:55 +00:00
section.
## Running Examples
The absolute fastest way to start experimenting with Rocket is to clone the
Rocket repository and run the included examples in the `examples/` directory.
For instance, the following set of commands runs the `hello_world` example:
```sh
git clone https://github.com/SergioBenitez/Rocket
cd Rocket
2017-08-11 16:32:27 +00:00
git checkout v0.4.0-dev
cd examples/hello_world
cargo run
```
There are numerous examples in the `examples/` directory. They can all be run
with `cargo run`.
! note
The examples' `Cargo.toml` files will point to the locally cloned `rocket`
libraries. When copying the examples for your own use, you should modify the
`Cargo.toml` files as explained in the [Getting Started] guide.
[Getting Started]: ../getting-started