-
Notifications
You must be signed in to change notification settings - Fork 39
docs: update installation instructions for 1.54.0 #20
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
5f2ea5d
docs: update installation instructions for 1.54.0
georgik 1dfbb97
update Dockerfile and revert aarch64 to 1.53
georgik c8b0b14
aarch64 package of Rust 1.54.0
georgik c555cbd
docs: correction in toolchain directory name
georgik 986cb6d
docs: add quotes to avoid curly braces expansion with copy and paste …
georgik 05df2fb
windows: use single bundle of compiler and src
georgik 1c00141
windows: modification of PATH is necessary
georgik 933fbcb
docs: add instructions for selection of the architecture
georgik 7e90321
docs: fix reference to parent document
georgik 315d5e3
docker: publish idf-rust image under Espressif account
georgik File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -19,4 +19,4 @@ jobs: | |
| with: | ||
| context: . | ||
| push: true | ||
| tags: georgikrocks/esp-idf-rust:latest | ||
| tags: espressif/idf-rust:latest | ||
This file contains hidden or 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
This file contains hidden or 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,35 +1,69 @@ | ||
| # Rust on Xtensa Installation for macOS M1 | ||
|
|
||
| Following instructions are specific for ESP32 and ESP32-S series based on Xtensa architecture. | ||
|
|
||
| Instructions for ESP-C series based on RISC-V architecture are described in document for [ESP32-C3](../README.md#esp32-c3). | ||
|
|
||
| Tested OS: macOS Big Sur M1 | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - rustup - https://rustup.rs/ | ||
|
|
||
| ## Commands | ||
| ## Installation commands | ||
|
|
||
| ``` | ||
| ```sh | ||
| rustup toolchain install nightly | ||
|
|
||
| mkdir -p ~/.rustup/toolchains/esp | ||
| VERSION="1.54.0-dev" | ||
| ARCH="aarch64-apple-darwin" | ||
| RUST_DIST="rust-${VERSION}-${ARCH}" | ||
| RUST_SRC_DIST="rust-src-${VERSION}" | ||
| TOOLCHAIN_DESTINATION_DIR="~/.rustup/toolchains/esp" | ||
|
|
||
| mkdir -p ${TOOLCHAIN_DESTINATION_DIR} | ||
|
|
||
| wget --continue https://dl.espressif.com/dl/idf-rust/dist/aarch64-apple-darwin/rust-1.53.0-dev-aarch64-apple-darwin.tar.xz | ||
| tar xvf rust-1.53.0-dev-aarch64-apple-darwin.tar.xz | ||
| ./rust-1.53.0-dev-aarch64-apple-darwin/install.sh --destdir=~/.rustup/toolchains/esp --prefix="" --without=rust-docs | ||
| wget "https://dl.espressif.com/dl/idf-rust/dist/${ARCH}/${RUST_DIST}.tar.xz" | ||
| tar xvf ${RUST_DIST}.tar.xz | ||
| ./${RUST_DIST}/install.sh --destdir=${TOOLCHAIN_DESTINATION_DIR} --prefix="" --without=rust-docs | ||
|
|
||
| wget --continue https://dl.espressif.com/dl/idf-rust/dist/noarch/rust-src-1.53.0-dev.tar.xz | ||
| tar xvf rust-src-1.53.0-dev.tar.xz | ||
| ./rust-src-1.53.0-dev/install.sh --destdir=~/.rustup/toolchains/esp --prefix="" | ||
| wget "https://dl.espressif.com/dl/idf-rust/dist/noarch/${RUST_SRC_DIST}.tar.xz" | ||
| tar xvf ${RUST_SRC_DIST}.tar.xz | ||
| ./${RUST_SRC_DIST}/install.sh --destdir=${TOOLCHAIN_DESTINATION_DIR} --prefix="" --without=rust-docs | ||
|
|
||
| rustup default esp | ||
|
|
||
| wget --continue https://dl.espressif.com/dl/idf-rust/dist/aarch64-apple-darwin/xtensa-esp32-elf-llvm11_0_0-aarch64-apple-darwin.tar.xz | ||
| wget --continue "https://dl.espressif.com/dl/idf-rust/dist/${ARCH}/xtensa-esp32-elf-llvm11_0_0-aarch64-apple-darwin.tar.xz" | ||
| tar xf xtensa-esp32-elf-llvm11_0_0-aarch64-apple-darwin.tar.xz | ||
| export PATH="`pwd`/xtensa-esp32-elf-clang/bin/:$PATH" | ||
|
|
||
| wget --continue https://github.com/espressif/rust-esp32-example/archive/refs/heads/main.zip | ||
| unzip main.zip | ||
| cd rust-esp32-example-main | ||
| idf.py build | ||
| ``` | ||
|
|
||
| ## Select architecture for the build | ||
|
|
||
| For the ESP32 - default (Xtensa architecture): | ||
|
|
||
| ```sh | ||
| idf.py set-target esp32 | ||
| ``` | ||
|
|
||
| For the ESP32-S2 (Xtensa architecture): | ||
|
|
||
| ```sh | ||
| idf.py set-target esp32s2 | ||
| ``` | ||
|
|
||
| For the ESP32-S3 (Xtensa architecture): | ||
|
|
||
| ```sh | ||
| idf.py set-target esp32s3 | ||
| ``` | ||
|
|
||
| ## Build and flash | ||
|
|
||
| ```sh | ||
| idf.py build flash | ||
| ``` | ||
This file contains hidden or 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,35 +1,68 @@ | ||
| # Rust on Xtensa Installation for macOS x64 | ||
|
|
||
| Tested OS: macOS Big Sur x64 | ||
| Following instructions are specific for ESP32 and ESP32-S series based on Xtensa architecture. | ||
|
|
||
| Instructions for ESP-C series based on RISC-V architecture are described in document for [ESP32-C3](../README.md#esp32-c3). | ||
|
|
||
| Tested OS: macOS Big Sur x64 | ||
| ## Prerequisites | ||
|
|
||
| - rustup - installed with nightly toolchain - https://rustup.rs/ | ||
|
|
||
| ## Commands | ||
| ## Installation commands | ||
|
|
||
| ``` | ||
| ```sh | ||
| rustup toolchain install nightly | ||
|
|
||
| mkdir -p ~/.rustup/toolchains/esp | ||
| VERSION="1.54.0-dev" | ||
| ARCH="x86_64-apple-darwin" | ||
| RUST_DIST="rust-${VERSION}-${ARCH}" | ||
| RUST_SRC_DIST="rust-src-${VERSION}" | ||
| TOOLCHAIN_DESTINATION_DIR="~/.rustup/toolchains/esp" | ||
|
|
||
| mkdir -p ${TOOLCHAIN_DESTINATION_DIR} | ||
|
|
||
| wget https://dl.espressif.com/dl/idf-rust/dist/x86_64-apple-darwin/rust-1.53.0-dev-x86_64-apple-darwin.tar.xz | ||
| tar xvf rust-1.53.0-dev-x86_64-apple-darwin.tar.xz | ||
| ./rust-1.53.0-dev-x86_64-apple-darwin/install.sh --destdir=~/.rustup/toolchains/esp --prefix="" --without=rust-docs | ||
| wget "https://dl.espressif.com/dl/idf-rust/dist/${ARCH}/${RUST_DIST}.tar.xz" | ||
| tar xvf ${RUST_DIST}.tar.xz | ||
| ./${RUST_DIST}/install.sh --destdir=${TOOLCHAIN_DESTINATION_DIR} --prefix="" --without=rust-docs | ||
|
|
||
| wget https://dl.espressif.com/dl/idf-rust/dist/noarch/rust-src-1.53.0-dev.tar.xz | ||
| tar xvf rust-src-1.53.0-dev.tar.xz | ||
| ./rust-src-1.53.0-dev/install.sh --destdir=~/.rustup/toolchains/esp --prefix="" --without=rust-docs | ||
| wget "https://dl.espressif.com/dl/idf-rust/dist/noarch/${RUST_SRC_DIST}.tar.xz" | ||
| tar xvf ${RUST_SRC_DIST}.tar.xz | ||
| ./${RUST_SRC_DIST}/install.sh --destdir=${TOOLCHAIN_DESTINATION_DIR} --prefix="" --without=rust-docs | ||
|
|
||
| rustup default esp | ||
|
|
||
| wget https://dl.espressif.com/dl/idf-rust/dist/x86_64-apple-darwin/xtensa-esp32-elf-llvm11_0_0-x86_64-apple-darwin.tar.xz | ||
| wget "https://dl.espressif.com/dl/idf-rust/dist/${ARCH}/xtensa-esp32-elf-llvm11_0_0-x86_64-apple-darwin.tar.xz" | ||
| tar xf xtensa-esp32-elf-llvm11_0_0-x86_64-apple-darwin.tar.xz | ||
| export PATH="`pwd`/xtensa-esp32-elf-clang/bin/:$PATH" | ||
|
|
||
| wget --continue https://github.com/espressif/rust-esp32-example/archive/refs/heads/main.zip | ||
| unzip main.zip | ||
| cd rust-esp32-example-main | ||
| idf.py build | ||
| ``` | ||
|
|
||
| ## Select architecture for the build | ||
|
|
||
| For the ESP32 - default (Xtensa architecture): | ||
|
|
||
| ```sh | ||
| idf.py set-target esp32 | ||
| ``` | ||
|
|
||
| For the ESP32-S2 (Xtensa architecture): | ||
|
|
||
| ```sh | ||
| idf.py set-target esp32s2 | ||
| ``` | ||
|
|
||
| For the ESP32-S3 (Xtensa architecture): | ||
|
|
||
| ```sh | ||
| idf.py set-target esp32s3 | ||
| ``` | ||
|
|
||
| ## Build and flash | ||
|
|
||
| ```sh | ||
| idf.py build flash | ||
| ``` |
This file contains hidden or 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
57 changes: 46 additions & 11 deletions
57
docs/rust-on-xtensa-installation-x86_64-unknown-linux-gnu.md
This file contains hidden or 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,36 +1,71 @@ | ||
| # Rust on Xtensa Installation for Linux x64 | ||
|
|
||
| Following instructions are specific for ESP32 and ESP32-S series based on Xtensa architecture. | ||
|
|
||
| Instructions for ESP-C series based on RISC-V architecture are described in document for [ESP32-C3](../README.md#esp32-c3). | ||
|
|
||
| Tested OS: Ubuntu 18 x64, Ubuntu 20 x64, Mint 20 x64, OpenSUSE Thumbleweed | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - rustup - installed with nightly toolchain - https://rustup.rs/ | ||
|
|
||
| ## Commands | ||
| ## Installation commands | ||
|
|
||
| ``` | ||
| ```sh | ||
| sudo apt install gcc wget xz-utils | ||
|
|
||
| rustup toolchain install nightly | ||
|
|
||
| mkdir -p ~/.rustup/toolchains/esp | ||
| VERSION="1.54.0-dev" | ||
| ARCH="x86_64-unknown-linux-gnu" | ||
| RUST_DIST="rust-${VERSION}-${ARCH}" | ||
| RUST_SRC_DIST="rust-src-${VERSION}" | ||
| TOOLCHAIN_DESTINATION_DIR="~/.rustup/toolchains/esp" | ||
|
|
||
| wget https://dl.espressif.com/dl/idf-rust/dist/x86_64-unknown-linux-gnu/rust-1.53.0-dev-x86_64-unknown-linux-gnu.tar.xz | ||
| tar xvf rust-1.53.0-dev-x86_64-unknown-linux-gnu.tar.xz | ||
| ./rust-1.53.0-dev-x86_64-unknown-linux-gnu/install.sh --destdir=~/.rustup/toolchains/esp --prefix="" --without=rust-docs | ||
| mkdir -p ${TOOLCHAIN_DESTINATION_DIR} | ||
|
|
||
| wget https://dl.espressif.com/dl/idf-rust/dist/noarch/rust-src-1.53.0-dev.tar.xz | ||
| tar xvf rust-src-1.53.0-dev.tar.xz | ||
| ./rust-src-1.53.0-dev/install.sh --destdir=~/.rustup/toolchains/esp --prefix="" --without=rust-docs | ||
| wget https://dl.espressif.com/dl/idf-rust/dist/${ARCH}/${RUST_DIST}.tar.xz | ||
| tar xvf ${RUST_DIST}.tar.xz | ||
| ./${RUST_DIST}/install.sh --destdir=${TOOLCHAIN_DESTINATION_DIR} --prefix="" --without=rust-docs | ||
|
|
||
| wget https://dl.espressif.com/dl/idf-rust/dist/noarch/${RUST_SRC_DIST}.tar.xz | ||
| tar xvf ${RUST_SRC_DIST}.tar.xz | ||
| ./${RUST_SRC_DIST}/install.sh --destdir=${TOOLCHAIN_DESTINATION_DIR} --prefix="" --without=rust-docs | ||
|
|
||
| rustup default esp | ||
|
|
||
| wget https://dl.espressif.com/dl/idf-rust/dist/x86_64-unknown-linux-gnu/xtensa-esp32-elf-llvm11_0_0-llvmorg-11-init-21249-g36dbc8b-linux-amd64.tar.xz | ||
| wget https://dl.espressif.com/dl/idf-rust/dist/${ARCH}/xtensa-esp32-elf-llvm11_0_0-llvmorg-11-init-21249-g36dbc8b-linux-amd64.tar.xz | ||
| tar xf xtensa-esp32-elf-llvm11_0_0-llvmorg-11-init-21249-g36dbc8b-linux-amd64.tar.xz | ||
| export PATH="`pwd`/xtensa-esp32-elf-clang/bin/:$PATH" | ||
|
|
||
| wget --continue https://github.com/espressif/rust-esp32-example/archive/refs/heads/main.zip | ||
| unzip main.zip | ||
| cd rust-esp32-example-main | ||
| idf.py build | ||
| ``` | ||
|
|
||
| ## Select architecture for the build | ||
|
|
||
| For the ESP32 - default (Xtensa architecture): | ||
|
|
||
| ```sh | ||
| idf.py set-target esp32 | ||
| ``` | ||
|
|
||
| For the ESP32-S2 (Xtensa architecture): | ||
|
|
||
| ```sh | ||
| idf.py set-target esp32s2 | ||
| ``` | ||
|
|
||
| For the ESP32-S3 (Xtensa architecture): | ||
|
|
||
| ```sh | ||
| idf.py set-target esp32s3 | ||
| ``` | ||
|
|
||
| ## Build and flash | ||
|
|
||
| ```sh | ||
| idf.py build flash | ||
| ``` |
This file contains hidden or 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
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.