rust README

The project's README from github.com/rust-lang/rust. As one markdown file: README.md.

The Rust Programming Language: A language empowering everyone to build reliable and efficient software

Website | Getting started | Learn | Documentation | Contributing

This is the main source code repository for Rust. It contains the compiler, standard library, and documentation.

Why Rust?

Quick Start

Read "Installation" from The Book.

Installing from Source

If you really want to install from source (though this is not recommended), see INSTALL.md.

Getting Help

See https://www.rust-lang.org/community for a list of chat platforms and forums.

Contributing

See CONTRIBUTING.md.

For a detailed explanation of the compiler's architecture and how to begin contributing, see the rustc-dev-guide.

License

Rust is primarily distributed under the terms of both the MIT license and the Apache License (Version 2.0), with portions covered by various BSD-like licenses.

See LICENSE-APACHE, LICENSE-MIT, and COPYRIGHT for details.

Trademark

The Rust Foundation owns and protects the Rust and Cargo trademarks and logos (the "Rust Trademarks").

If you want to use these names or brands, please read the Rust language trademark policy.

Third-party logos may be subject to third-party copyrights and trademarks. See Licenses for details.

rust (rust-lang/rust)

cloud
Searching Database…

120.5K ·GitHub
What is this?This is the main source repository for the Rust programming language — it contains the compiler (rustc), the standard library, and documentation.
Is this the compiler itself, or a library I add to a project?It is the compiler toolchain and standard library source, not something you add as a dependency — you install the Rust toolchain itself and then use Cargo to build and manage your own projects.
How do I install Rust?Follow the 'Installation' chapter in The Book, which walks through installing the Rust toolchain (typically via rustup).
Do I need anything besides the toolchain itself to get started?No extra tooling is required upfront — the toolchain bundles Cargo as the package manager and build tool, plus rustfmt for formatting, Clippy for linting, and rust-analyzer for editor support.
Is building Rust from source recommended?No — the README explicitly warns that installing from source is not recommended; most users should install a prebuilt toolchain instead.
Does Rust work cross-platform, including on embedded devices?Yes — Rust is designed to be fast and memory-efficient, making it suitable for critical services and embedded devices as well as desktop platforms like Windows, macOS, and Linux.
What is Cargo?Cargo is Rust's built-in package manager and build tool, used to manage dependencies, compile code, and run tests.
What tools come with the Rust toolchain besides the compiler?The toolchain includes rustfmt for auto-formatting, Clippy as a linter, and rust-analyzer for editor integration.
Why is Rust considered memory-safe without a garbage collector?Rust's ownership model and rich type system enforce memory and thread safety at compile time, catching many bugs before the program ever runs.
What are similar projects?goose, mquickjs, carbon-lang, CalcKernel, Odin, Singeli, sway, lua
Creator
rust-lang
Size
1000.5 MB
Stars
120.5K
Age
16y
Commits · 90 Days