mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

clean up README

Browse Source
This commit is contained in:
Steve Klabnik 2015-02-16 17:32:12 -05:00
parent 96bea5eb72
commit 3f9b0999d1
1 changed files with 1 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
src/doc/style/README.md
View File

@ -1,4 +1,4 @@
% Rust Guidelines [working title]
% Style Guidelines
This document collects the emerging principles, conventions, abstractions, and
best practices for writing Rust code.
@ -10,19 +10,6 @@ drive discussion, consensus and adoption.
Whenever feasible, guidelines provide specific examples from Rust's standard
libraries.
For now, you can find a rendered snapshot at
[http://aturon.github.io/](http://aturon.github.io/). After
[some infrastructure work](https://github.com/aturon/rust-guidelines/issues/17), the snapshot will move somewhere more
official.
### Building the document
Like http://rustbyexample.com/, this guidelines document is written in
the [`gitbook`](https://github.com/GitbookIO/gitbook) style. It can be
compiled with a prototype tool,
[`rustbook`](https://github.com/aturon/rust-book) that provides a
minimal subset of `gitbook`'s functionality on top of `rustdoc`.
### Guideline statuses
Every guideline has a status: