Skip to content

Commit dd3d426

Browse files
committed
feat: Remove bash script
1 parent f5d8a16 commit dd3d426

File tree

4 files changed

+14
-842
lines changed

4 files changed

+14
-842
lines changed

.github/workflows/upload-installer.yaml

Lines changed: 0 additions & 61 deletions
This file was deleted.

README.md

Lines changed: 13 additions & 109 deletions
Original file line numberDiff line numberDiff line change
@@ -10,33 +10,28 @@ If you want to know more about the Rust ecosystem on ESP targets, see [The Rust
1010

1111
## Table of Contents
1212

13-
- [rust-build](#rust-build)
14-
- [Table of Contents](#table-of-contents)
15-
- [Xtensa Installation](#xtensa-installation)
13+
- [Xtensa Installation](#xtensa-installation)
1614
- [`espup` installation](#espup-installation)
17-
- [Download installer in Bash](#download-installer-in-bash)
18-
- [Linux and macOS](#linux-and-macos)
19-
- [Prerequisites](#prerequisites)
20-
- [Installation commands](#installation-commands)
21-
- [Set up the environment variables](#set-up-the-environment-variables)
22-
- [Arguments](#arguments)
23-
- [Windows Long path limitation](#windows-long-path-limitation)
2415
- [Windows x86\_64 MSVC](#windows-x86_64-msvc)
2516
- [Prerequisites x86\_64 MSVC](#prerequisites-x86_64-msvc)
2617
- [Windows x86\_64 GNU](#windows-x86_64-gnu)
2718
- [Prerequisites x86\_64 GNU](#prerequisites-x86_64-gnu)
28-
- [Long path limitation](#long-path-limitation)
29-
- [RISC-V Installation](#risc-v-installation)
30-
- [Building projects](#building-projects)
31-
- [Cargo first approach](#cargo-first-approach)
32-
- [Idf first approach](#idf-first-approach)
33-
- [Using Containers](#using-containers)
34-
- [Using Dev Containers](#using-dev-containers)
19+
- [RISC-V Installation](#risc-v-installation)
20+
- [Building projects](#building-projects)
21+
- [Cargo first approach](#cargo-first-approach)
22+
- [Idf first approach](#idf-first-approach)
23+
- [Using Containers](#using-containers)
24+
- [Using Dev Containers](#using-dev-containers)
25+
- [Release process](#release-process)
26+
- [Building release](#building-release)
27+
- [Finalization of release (about 2-3 days later)](#finalization-of-release-about-2-3-days-later)
28+
- [Rollback release](#rollback-release)
29+
- [Uploading new image tags to espressif/idf-rust](#uploading-new-image-tags-to-espressifidf-rust)
3530

3631
## Xtensa Installation
3732

3833
Deployment is done using [`espup`](https://github.com/esp-rs/espup#installation)
39-
## `espup` installation
34+
### `espup` installation
4035
```sh
4136
cargo install espup
4237
espup install # To install Espressif Rust ecosystem
@@ -89,89 +84,6 @@ Or, downloading the pre-compiled release binaries:
8984

9085
> For Windows MSVC/GNU, Rust environment can also be installed with Universal Online idf-installer: https://dl.espressif.com/dl/esp-idf/
9186
92-
93-
#### Download installer in Bash
94-
95-
**Deprecated method**
96-
97-
```bash
98-
curl -LO https://github.com/esp-rs/rust-build/releases/download/v1.75.0.0/install-rust-toolchain.sh
99-
chmod a+x install-rust-toolchain.sh
100-
```
101-
102-
### Linux and macOS
103-
104-
The following instructions are specific for the ESP32 and ESP32-S series based on Xtensa architecture.
105-
106-
Instructions for ESP-C series based on RISC-V architecture are described in [RISC-V section](#risc-v-installation).
107-
108-
#### Prerequisites
109-
110-
- Linux:
111-
- [Dependencies (command for Ubuntu/Debian)](https://github.com/esp-rs/esp-idf-template/blob/master/cargo/.devcontainer/Dockerfile#L16):
112-
```sh
113-
apt-get install -y git curl gcc clang ninja-build cmake libudev-dev unzip xz-utils \
114-
python3 python3-pip python3-venv libusb-1.0-0 libssl-dev pkg-config libpython2.7
115-
```
116-
117-
No prerequisites are needed for macOS.
118-
119-
#### Installation commands
120-
121-
```sh
122-
git clone https://github.com/esp-rs/rust-build.git
123-
cd rust-build
124-
./install-rust-toolchain.sh
125-
. ./export-esp.sh
126-
```
127-
128-
Run `./install-rust-toolchain.sh --help` for more information about arguments.
129-
130-
Installation of different version of the toolchain:
131-
132-
```
133-
./install-rust-toolchain.sh --toolchain-version 1.75.0.0
134-
. ./export-esp.sh
135-
```
136-
137-
#### Set up the environment variables
138-
We need to update environment variables as some of the installed tools are not
139-
yet added to the PATH environment variable, we also need to add LIBCLANG_PATH
140-
environment variable to avoid conflicts with the system Clang. The environment
141-
variables that we need to update are shown at the end of the install script and
142-
stored in an export file. By default this export file is `export-esp.sh` but can
143-
be modified with the `-f|--export-file` argument.
144-
145-
We must set the environment variables in every terminal session.
146-
147-
148-
> **Note**
149-
> If the export variables are added to the shell startup script, the shell may need to be refreshed.
150-
151-
#### Arguments
152-
- `-b|--build-target`: Comma separated list of targets \[`esp32,esp32s2,esp32s3,esp32c3,all`]. Defaults to: `esp32,esp32s2,esp32s3`
153-
- `-c|--cargo-home`: Cargo path.
154-
- `-d|--toolchain-destination`: Toolchain installation folder. Defaults to: `<rustup_home>/toolchains/esp`
155-
- `-e|--extra-crates`: Extra crates to install. Defaults to: `ldproxy cargo-espflash`
156-
- `-f|--export-file`: Destination of the export file generated. Defaults to: `export-esp.sh`
157-
- `-i|--installation-mode`: Installation mode: \[`install, reinstall, uninstall`]. Defaults to: `install`
158-
- `-k|--minified-llvm`: Use minified LLVM. Possible values: \[`YES, NO`]. Defaults to: `YES`
159-
- `-l|--llvm-version`: LLVM version.
160-
- `-m|--minified-esp-idf`: \[Only applies if using `-s|--esp-idf-version`]. Deletes some idf folders to save space. Possible values \[`YES, NO`]. Defaults to: `NO`
161-
- `-n|--nightly-version`: Nightly Rust toolchain version. Defaults to: `nightly`
162-
- `-r|--rustup-home`: Path to .rustup. Defaults to: `~/.rustup`
163-
- `-s|--esp-idf-version`: [ESP-IDF branch](https://github.com/espressif/esp-idf/branches) to install. When empty, no esp-idf is installed. Default: `""`
164-
- `-t|--toolchain-version`: Xtensa Rust toolchain version
165-
- `-x|--clear-cache`: Removes cached distribution files. Possible values: \[`YES, NO`]. Defaults to: `YES`
166-
167-
#### Windows Long path limitation
168-
169-
Several build tools have problem with long paths on Windows including Git and CMake. We recommend to put project on short path or use command `subst` to map the directory with the project to separate disk letter.
170-
171-
```
172-
subst "R:" "rust-project"
173-
```
174-
17587
### Windows x86_64 MSVC
17688

17789
The following instructions are specific for the ESP32 and ESP32-S series based on Xtensa architecture. If you do not have Visual Studio and Windows 10 SDK installed, consider the alternative option [Windows x86_64 GNU](#windows-x86_64-gnu).
@@ -237,14 +149,6 @@ Invoke-WebRequest 'https://github.com/esp-rs/espup/releases/latest/download/espu
237149
.\espup.exe install
238150
```
239151

240-
#### Long path limitation
241-
242-
Several build tools have problem with long paths on Windows including Git and CMake. We recommend to put project on short path or use command `subst` to map the directory with the project to separate disk letter.
243-
244-
```
245-
subst "R:" "rust-project"
246-
```
247-
248152
## RISC-V Installation
249153

250154
The following instructions are specific for ESP32-C based on RISC-V architecture.

build-template-project.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ chmod u+x ${HOME}/.cargo/bin/cargo-generate
77
export USER=esp
88
source /home/esp/export-esp.sh
99

10-
# Build esp-idf-template (release/v4.4)
10+
# Build esp-idf-template
1111
cargo generate esp-rs/esp-idf-template cargo --name test-std-$1 --vcs none --silent -d mcu=$1 -d advanced=false
1212
cd test-std-$1
1313
cargo build

0 commit comments

Comments
 (0)