-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy pathindex.html
79 lines (65 loc) · 3.52 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
<!DOCTYPE html>
<html>
<head>
<title>avr-rust :: Homepage</title>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css" integrity="sha384-BVYiiSIFeK1dGmJRAkycuHAHRg32OmUcww7on3RYdg4Va+PmSTsz/K68vbdEjh4u" crossorigin="anonymous">
</head>
<body>
<div class="container">
<div class="text-center">
<h1>The avr-rust Project Homepage</h1>
<p>
An open source project adding AVR microcontroller support to Rust.
</p>
<img src="res/images/avr-rust-logo.png" />
<p>
The avr-rust compiler, once existing as a <a href="https://github.com/avr-rust/rust">fork</a>, has since been merged into upstream Rust as of July 2020. <br />
The standard Rust nightly compiler can be used to compile crates for AVR - no compiling from source required.
</p>
<p>
The recommended way to use avr-rust is via <a href="#installation-rustup">rustup</a> using the official nightly version of the Rust compiler.
</p>
</div>
<hr />
<h2 class="font-weight-normal">Links and Resources</h2>
<div class="list-group">
<a href="https://book.avr-rust.com/" target="_blank" class="list-group-item">Guidebook</a>
<a href="https://github.com/avr-rust" class="list-group-item">
<img src="res/images/github-logo.png" style="width: 50px">
GitHub
</a>
<a href="https://gitter.im/avr-rust/Lobby" class="list-group-item">
<img src="res/images/gitter-logo.png" style="width: 100px">
for discussion
</a>
<a href="https://github.com/avr-rust/awesome-avr-rust" target="_blank" class="list-group-item">list of avr-rust projects</a>
<a href="https://github.com/rust-lang/rust/labels/O-AVR" target="_blank" class="list-group-item">compiler issue tracker</a>
<a href="https://github.com/avr-rust/rust/issues" target="_blank" class="list-group-item">legacy compiler issue tracker (read only)</a>
</div>
<h2>Installation Instructions</h2>
<p>See <a href="https://book.avr-rust.com/002-installing-the-compiler.html#installing-or-building-from-source">guide book</a> to know more.</p>
<h3 id="installation-via-rustup">Installation via Rustup</h3>
<ol>
<li>Install <a href="https://rustup.rs/" target="_blank">rustup</a></li>
<li>
Install Rust <code>nightly</code> and <code>rust-src</code> via Rustup by typing the following snippet into a terminal.
The <code>rust-src</code> component is required to allow Rust to compile <code>libcore</code> for any chip being targeted.
<pre><code>$ rustup component add nightly rust-src</code></pre>
</li>
<li>Done!</li>
</ol>
<hr />
<p>
AVR can be enabled for a crate by running <code>$ rustup override set nightly</code> in a terminal inside the root directory of the desired crate.
</p>
<h3 id="compile-from-source">Compile from source</h3>
See <a href="https://rustc-dev-guide.rust-lang.org/getting-started.html">Rust development instruction</a>.
<h2>Report a compiler issue</h2>
<p>Create <a href="https://github.com/rust-lang/rust/labels/O-AVR">an issue on rust repository</a>.
</p>
<p>
AVR compiler issues are tracked on the official Rust GitHub repository. After creation, the triage team will tag the issue as <a href="https://github.com/rust-lang/rust/labels/O-AVR" target="_blank">O-AVR</a> for you.
</p>
</div>
</body>
</html>