src/doc/index.md

   1 % Rust Documentation
   2
   3 Welcome to the Rust documentation! You can use the section headings above
   4 to jump to any particular section.
   5
   6 # Getting Started
   7
   8 If you haven't seen Rust at all yet, the first thing you should read is the [30
   9 minute intro](intro.html). It will give you an overview of the basic ideas of Rust
  10 at a high level.
  11
  12 Once you know you really want to learn Rust, the next step is reading [The
  13 Rust Programming Language](book/index.html). It is a lengthy explanation of
  14 Rust, its syntax, and its concepts. Upon completing the book, you'll be an
  15 intermediate Rust developer, and will have a good grasp of the fundamental
  16 ideas behind Rust.
  17
  18 # Community & Getting Help
  19
  20 If you need help with something, or just want to talk about Rust with others,
  21 there's a few places you can do that:
  22
  23 The Rust IRC channels on [irc.mozilla.org](http://irc.mozilla.org/) are the
  24 fastest way to get help.
  25 [`#rust`](http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust) is
  26 the general discussion channel, and you'll find people willing to help you with
  27 any questions you may have.
  28
  29 There are also three specialty channels:
  30 [`#rust-gamedev`](http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-gamedev)
  31 and
  32 [`#rust-osdev`](http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-osdev)
  33 are for game development and operating system development, respectively.
  34 There's also
  35 [`#rust-internals`](http://chat.mibbit.com/?server=irc.mozilla.org&channel=%23rust-internals), which is for discussion of the development of Rust itself.
  36
  37 You can also get help on [Stack
  38 Overflow](http://stackoverflow.com/questions/tagged/rust). Searching for your
  39 problem might reveal someone who has asked it before!
  40
  41 There is an active [subreddit](http://reddit.com/r/rust) with lots of
  42 discussion and news about Rust.
  43
  44 There is also a [user forum](http://users.rust-lang.org), for all
  45 user-oriented discussion, and a [developer
  46 forum](http://internals.rust-lang.org/), where the development of Rust
  47 itself is discussed.
  48
  49 # Specification
  50
  51 Rust does not have an exact specification, but an effort to describe as much of
  52 the language in as much detail as possible is in [the reference](reference.html).
  53
  54 # Tools
  55
  56 Rust's still a young language, so there isn't a ton of tooling yet, but the
  57 tools we have are really nice.
  58
  59 [Cargo](http://crates.io) is Rust's package manager, and its website contains
  60 lots of good documentation.
  61
  62 [`rustdoc`](book/documentation.html) is used to generate documentation for Rust code.
  63
  64 # FAQs
  65
  66 There are questions that are asked quite often, and so we've made FAQs for them:
  67
  68 * [Language Design FAQ](complement-design-faq.html)
  69 * [Language FAQ](complement-lang-faq.html)
  70 * [Project FAQ](complement-project-faq.html)
  71 * [How to submit a bug report](complement-bugreport.html)
  72
  73 # The standard library
  74
  75 We have [API documentation for the entire standard
  76 library](std/index.html). There's a list of crates on the left with more
  77 specific sections, or you can use the search bar at the top to search for
  78 something if you know its name.
  79
  80 # External documentation
  81
  82 *Note: While these are great resources for learning Rust, they may track a
  83 particular version of Rust that is likely not exactly the same as that for
  84 which this documentation was generated.*
  85
  86 * [Rust by Example] - Short examples of common tasks in Rust (tracks the master
  87   branch).
  88 * [Rust for Rubyists] - The first community tutorial for Rust. Tracks the last
  89   stable release. Not just for Ruby programmers.
  90
  91 [Rust by Example]: http://rustbyexample.com/
  92 [Rust for Rubyists]: http://www.rustforrubyists.com/