Skip to content

Commit 435fc68

Browse files
committed
Add Xtensa README content.
1 parent e080dd7 commit 435fc68

File tree

1 file changed

+29
-3
lines changed

1 file changed

+29
-3
lines changed

README.md

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,32 @@
1-
<a href = "https://www.rust-lang.org/">
2-
<img width = "90%" height = "auto" src = "https://img.shields.io/badge/Rust-Programming%20Language-black?style=flat&logo=rust" alt = "The Rust Programming Language">
3-
</a>
1+
# The Rust Programming Language For Xtensa processors
2+
3+
This fork enables projects to be built for the ESP32 and ESP8266 using [espressif's llvm fork](https://github.com/espressif/llvm-project). The [esp-rs](https://github.com/esp-rs) organization has been formed to develop runtime, pac and hal crates for the esp32 and eventually esp8266.
4+
5+
Join in on the discussion: https://matrix.to/#/#esp-rs:matrix.org!
6+
7+
## Using this fork
8+
9+
The [quickstart repo](https://github.com/MabezDev/xtensa-rust-quickstart) has more information on how to build this fork and use it to build xtensa compatible code.
10+
11+
This is the main source code repository for [Rust]. It contains the compiler,
12+
standard library, and documentation.
13+
14+
To build this fork and have xtensa support, you need to make sure you pass in the --experimental-targets=Xtensa to configure as follows:
15+
```sh
16+
$ git clone https://github.com/MabezDev/rust-xtensa
17+
$ cd rust-xtensa
18+
$ ./configure --experimental-targets=Xtensa
19+
$ ./x.py build
20+
```
21+
22+
## Updating this fork
23+
24+
The patch set can be found [here](https://github.com/MabezDev/rust-xtensa-patches). Checkout from upstream/master, apply the patches, fixing any conflicts if necessary (remember to PR the changes back to the patches [repo]((https://github.com/MabezDev/rust-xtensa-patches))). Once it builds submit a PR against this repo with the branch name `xtensa-update-$DATE`.
25+
26+
Once accepted, the new branch will be renamed `xtensa-target`, hence making it the default.
27+
Don't worry about the README changes, I will port those across once I accept the PR.
28+
29+
---
430

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

0 commit comments

Comments
 (0)