forked from rust-lang/rust
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[AVR][No Upstream] Add AVR-Rust README
- Loading branch information
1 parent
26015da
commit 0ea0a96
Showing
2 changed files
with
264 additions
and
209 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,226 +1,55 @@ | ||
| # The Rust Programming Language | ||
| # Rust with AVR support | ||
|
|
||
| This is the main source code repository for [Rust]. It contains the compiler, | ||
| standard library, and documentation. | ||
| [](https://gitter.im/avr-rust) | ||
|
|
||
| [Rust]: https://www.rust-lang.org | ||
| This project adds support for the [AVR](https://en.wikipedia.org/wiki/Atmel_AVR) | ||
| microcontroller to Rust. | ||
|
|
||
| ## Quick Start | ||
| It uses the [AVR-LLVM backend](http://llvm.org/viewvc/llvm-project/llvm/trunk/lib/Target/AVR/). | ||
|
|
||
| Read ["Installation"] from [The Book]. | ||
| This will compile Rust with AVR support. This will not create a | ||
| fully-fledged cross-compiler, however, as it does not compile any libraries | ||
| such as `libcore` or `liblibc`. To do this, the `--target=avr-unknown-unknown` | ||
| flag must be passed to `configure`, which is not fully supported yet due to bugs. | ||
|
|
||
| ["Installation"]: https://doc.rust-lang.org/book/second-edition/ch01-01-installation.html | ||
| [The Book]: https://doc.rust-lang.org/book/index.html | ||
| ``` bash | ||
| # Grab the avr-rust sources | ||
| git clone https://github.com/avr-rust/rust.git | ||
|
|
||
| ## Building from Source | ||
| # Create a directory to place built files in | ||
| mkdir build && cd build | ||
|
|
||
| 1. Make sure you have installed the dependencies: | ||
| # Generate Makefile using settings suitable for an experimental compiler | ||
| ../rust/configure \ | ||
| --enable-debug \ | ||
| --disable-docs \ | ||
| --enable-llvm-assertions \ | ||
| --enable-debug-assertions \ | ||
| --enable-optimize \ | ||
| --prefix=/opt/avr-rust | ||
|
|
||
| * `g++` 4.7 or later or `clang++` 3.x or later | ||
| * `python` 2.7 (but not 3.x) | ||
| * GNU `make` 3.81 or later | ||
| * `cmake` 3.4.3 or later | ||
| * `curl` | ||
| * `git` | ||
| # Build the compiler, optionally install it to /opt/avr-rust | ||
| make | ||
| make install | ||
|
|
||
| 2. Clone the [source] with `git`: | ||
| # Register the toolchain with rustup | ||
| rustup toolchain link avr-toolchain $(realpath $(find . -name 'stage1')) | ||
|
|
||
| ```sh | ||
| $ git clone https://github.com/rust-lang/rust.git | ||
| $ cd rust | ||
| ``` | ||
|
|
||
| [source]: https://github.com/rust-lang/rust | ||
|
|
||
| 3. Build and install: | ||
|
|
||
| ```sh | ||
| $ ./x.py build && sudo ./x.py install | ||
| ``` | ||
|
|
||
| > ***Note:*** Install locations can be adjusted by copying the config file | ||
| > from `./config.toml.example` to `./config.toml`, and | ||
| > adjusting the `prefix` option under `[install]`. Various other options, such | ||
| > as enabling debug information, are also supported, and are documented in | ||
| > the config file. | ||
| When complete, `sudo ./x.py install` will place several programs into | ||
| `/usr/local/bin`: `rustc`, the Rust compiler, and `rustdoc`, the | ||
| API-documentation tool. This install does not include [Cargo], | ||
| Rust's package manager, which you may also want to build. | ||
|
|
||
| [Cargo]: https://github.com/rust-lang/cargo | ||
|
|
||
| ### Building on Windows | ||
|
|
||
| There are two prominent ABIs in use on Windows: the native (MSVC) ABI used by | ||
| Visual Studio, and the GNU ABI used by the GCC toolchain. Which version of Rust | ||
| you need depends largely on what C/C++ libraries you want to interoperate with: | ||
| for interop with software produced by Visual Studio use the MSVC build of Rust; | ||
| for interop with GNU software built using the MinGW/MSYS2 toolchain use the GNU | ||
| build. | ||
|
|
||
| #### MinGW | ||
|
|
||
| [MSYS2][msys2] can be used to easily build Rust on Windows: | ||
|
|
||
| [msys2]: https://msys2.github.io/ | ||
|
|
||
| 1. Grab the latest [MSYS2 installer][msys2] and go through the installer. | ||
|
|
||
| 2. Run `mingw32_shell.bat` or `mingw64_shell.bat` from wherever you installed | ||
| MSYS2 (i.e. `C:\msys64`), depending on whether you want 32-bit or 64-bit | ||
| Rust. (As of the latest version of MSYS2 you have to run `msys2_shell.cmd | ||
| -mingw32` or `msys2_shell.cmd -mingw64` from the command line instead) | ||
|
|
||
| 3. From this terminal, install the required tools: | ||
|
|
||
| ```sh | ||
| # Update package mirrors (may be needed if you have a fresh install of MSYS2) | ||
| $ pacman -Sy pacman-mirrors | ||
|
|
||
| # Install build tools needed for Rust. If you're building a 32-bit compiler, | ||
| # then replace "x86_64" below with "i686". If you've already got git, python, | ||
| # or CMake installed and in PATH you can remove them from this list. Note | ||
| # that it is important that you do **not** use the 'python2' and 'cmake' | ||
| # packages from the 'msys2' subsystem. The build has historically been known | ||
| # to fail with these packages. | ||
| $ pacman -S git \ | ||
| make \ | ||
| diffutils \ | ||
| tar \ | ||
| mingw-w64-x86_64-python2 \ | ||
| mingw-w64-x86_64-cmake \ | ||
| mingw-w64-x86_64-gcc | ||
| ``` | ||
|
|
||
| 4. Navigate to Rust's source code (or clone it), then build it: | ||
|
|
||
| ```sh | ||
| $ ./x.py build && ./x.py install | ||
| ``` | ||
|
|
||
| #### MSVC | ||
|
|
||
| MSVC builds of Rust additionally require an installation of Visual Studio 2013 | ||
| (or later) so `rustc` can use its linker. Make sure to check the “C++ tools” | ||
| option. | ||
|
|
||
| With these dependencies installed, you can build the compiler in a `cmd.exe` | ||
| shell with: | ||
|
|
||
| ```sh | ||
| > python x.py build | ||
| ``` | ||
|
|
||
| Currently building Rust only works with some known versions of Visual Studio. If | ||
| you have a more recent version installed the build system doesn't understand | ||
| then you may need to force rustbuild to use an older version. This can be done | ||
| by manually calling the appropriate vcvars file before running the bootstrap. | ||
|
|
||
| ``` | ||
| CALL "C:\Program Files (x86)\Microsoft Visual Studio 14.0\VC\bin\amd64\vcvars64.bat" | ||
| python x.py build | ||
| # Optionally enable the avr toolchain globally | ||
| rustup default avr-toolchain | ||
| ``` | ||
|
|
||
| #### Specifying an ABI | ||
|
|
||
| Each specific ABI can also be used from either environment (for example, using | ||
| the GNU ABI in powershell) by using an explicit build triple. The available | ||
| Windows build triples are: | ||
| - GNU ABI (using GCC) | ||
| - `i686-pc-windows-gnu` | ||
| - `x86_64-pc-windows-gnu` | ||
| - The MSVC ABI | ||
| - `i686-pc-windows-msvc` | ||
| - `x86_64-pc-windows-msvc` | ||
|
|
||
| The build triple can be specified by either specifying `--build=<triple>` when | ||
| invoking `x.py` commands, or by copying the `config.toml` file (as described | ||
| in Building From Source), and modifying the `build` option under the `[build]` | ||
| section. | ||
|
|
||
| ### Configure and Make | ||
|
|
||
| While it's not the recommended build system, this project also provides a | ||
| configure script and makefile (the latter of which just invokes `x.py`). | ||
|
|
||
| ```sh | ||
| $ ./configure | ||
| $ make && sudo make install | ||
| ``` | ||
|
|
||
| When using the configure script, the generated `config.mk` file may override the | ||
| `config.toml` file. To go back to the `config.toml` file, delete the generated | ||
| `config.mk` file. | ||
|
|
||
| ## Building Documentation | ||
|
|
||
| If you’d like to build the documentation, it’s almost the same: | ||
|
|
||
| ```sh | ||
| $ ./x.py doc | ||
| ``` | ||
|
|
||
| The generated documentation will appear under `doc` in the `build` directory for | ||
| the ABI used. I.e., if the ABI was `x86_64-pc-windows-msvc`, the directory will be | ||
| `build\x86_64-pc-windows-msvc\doc`. | ||
|
|
||
| ## Notes | ||
|
|
||
| Since the Rust compiler is written in Rust, it must be built by a | ||
| precompiled "snapshot" version of itself (made in an earlier state of | ||
| development). As such, source builds require a connection to the Internet, to | ||
| fetch snapshots, and an OS that can execute the available snapshot binaries. | ||
|
|
||
| Snapshot binaries are currently built and tested on several platforms: | ||
|
|
||
| | Platform / Architecture | x86 | x86_64 | | ||
| |--------------------------------|-----|--------| | ||
| | Windows (7, 8, Server 2008 R2) | ✓ | ✓ | | ||
| | Linux (2.6.18 or later) | ✓ | ✓ | | ||
| | OSX (10.7 Lion or later) | ✓ | ✓ | | ||
|
|
||
| You may find that other platforms work, but these are our officially | ||
| supported build environments that are most likely to work. | ||
|
|
||
| Rust currently needs between 600MiB and 1.5GiB to build, depending on platform. | ||
| If it hits swap, it will take a very long time to build. | ||
|
|
||
| There is more advice about hacking on Rust in [CONTRIBUTING.md]. | ||
|
|
||
| [CONTRIBUTING.md]: https://github.com/rust-lang/rust/blob/master/CONTRIBUTING.md | ||
|
|
||
| ## Getting Help | ||
|
|
||
| The Rust community congregates in a few places: | ||
|
|
||
| * [Stack Overflow] - Direct questions about using the language. | ||
| * [users.rust-lang.org] - General discussion and broader questions. | ||
| * [/r/rust] - News and general discussion. | ||
|
|
||
| [Stack Overflow]: https://stackoverflow.com/questions/tagged/rust | ||
| [/r/rust]: https://reddit.com/r/rust | ||
| [users.rust-lang.org]: https://users.rust-lang.org/ | ||
|
|
||
| ## Contributing | ||
|
|
||
| To contribute to Rust, please see [CONTRIBUTING](CONTRIBUTING.md). | ||
| ## Usage | ||
|
|
||
| Rust has an [IRC] culture and most real-time collaboration happens in a | ||
| variety of channels on Mozilla's IRC network, irc.mozilla.org. The | ||
| most popular channel is [#rust], a venue for general discussion about | ||
| Rust. And a good place to ask for help would be [#rust-beginners]. | ||
| # With Xargo (recommended) | ||
|
|
||
| [IRC]: https://en.wikipedia.org/wiki/Internet_Relay_Chat | ||
| [#rust]: irc://irc.mozilla.org/rust | ||
| [#rust-beginners]: irc://irc.mozilla.org/rust-beginners | ||
| Take a look at the example [blink](https://github.com/avr-rust/blink) program. | ||
|
|
||
| ## License | ||
| # Vanilla `rustc` | ||
|
|
||
| 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. | ||
| AVR support is enabled by passing the `--target avr-unknown-unknown` flag to `rustc`. | ||
|
|
||
| See [LICENSE-APACHE](LICENSE-APACHE), [LICENSE-MIT](LICENSE-MIT), and | ||
| [COPYRIGHT](COPYRIGHT) for details. | ||
| Note that the Rust `libcore` library (essentially required for every Rust program), | ||
| must be manually compiled for it to be used, as it will not be built for AVR during | ||
| compiler compilation (yet). Work is currently being done in order to allow `libcore` | ||
| to be automatically compiled for AVR. |
Oops, something went wrong.