From 909b3560ba6a8d7a7f8a4ede3d4c6ffb9fc71805 Mon Sep 17 00:00:00 2001 From: Nick Cameron Date: Wed, 16 Dec 2015 17:58:20 +1300 Subject: [PATCH] Add quick start info to README.md, cargo update. --- Cargo.lock | 6 +++--- Cargo.toml | 2 +- README.md | 13 +++++++++++++ 3 files changed, 17 insertions(+), 4 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 14afd0912485..8e4cb8912800 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1,6 +1,6 @@ [root] name = "rustfmt" -version = "0.1.0" +version = "0.2.0" dependencies = [ "diff 0.1.7 (registry+https://github.com/rust-lang/crates.io-index)", "env_logger 0.3.2 (registry+https://github.com/rust-lang/crates.io-index)", @@ -11,7 +11,7 @@ dependencies = [ "strings 0.0.1 (registry+https://github.com/rust-lang/crates.io-index)", "syntex_syntax 0.23.0 (registry+https://github.com/rust-lang/crates.io-index)", "term 0.2.14 (registry+https://github.com/rust-lang/crates.io-index)", - "toml 0.1.23 (registry+https://github.com/rust-lang/crates.io-index)", + "toml 0.1.24 (registry+https://github.com/rust-lang/crates.io-index)", "unicode-segmentation 0.1.2 (registry+https://github.com/rust-lang/crates.io-index)", ] @@ -129,7 +129,7 @@ dependencies = [ [[package]] name = "toml" -version = "0.1.23" +version = "0.1.24" source = "registry+https://github.com/rust-lang/crates.io-index" dependencies = [ "rustc-serialize 0.3.16 (registry+https://github.com/rust-lang/crates.io-index)", diff --git a/Cargo.toml b/Cargo.toml index 70f7f796baf9..bcba2f66818b 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,7 +1,7 @@ [package] name = "rustfmt" -version = "0.1.0" +version = "0.2.0" authors = ["Nicholas Cameron ", "Marcus Klaas ", "The Rustfmt contributors"] description = "Tool to find and fix Rust formatting issues" repository = "https://github.com/rust-lang-nursery/rustfmt" diff --git a/README.md b/README.md index f8dab7ec97ff..48620c80f64b 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,19 @@ A tool for formatting Rust code according to style guidelines. If you'd like to help out (and you should, it's a fun project!), see [Contributing.md](Contributing.md). +## Quick start + +To install: + +``` +cargo install --git https://github.com/rust-lang-nursery/rustfmt +``` + +to run on a cargo project in the current working directory: + +``` +cargo fmt +``` ## Installation