Skip to content

Commit 1c7a486

Browse files
Update readme (#289)
* docs: 📝 Update readme * docs: Udpate readme
1 parent 1a10ddc commit 1c7a486

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
1212
`espup` is a tool for installing and maintaining the required toolchains for developing applications in Rust for Espressif SoC's.
1313

14-
To better understand what `espup` installs, see [`Rust on ESP targets` chapter of `The Rust on ESP Book`](https://esp-rs.github.io/book/installation/index.html)
14+
To better understand what `espup` installs, see [the installation chapter of `The Rust on ESP Book`](https://esp-rs.github.io/book/installation/index.html)
1515

1616
## Requirements
1717

@@ -26,7 +26,7 @@ Linux systems also require the following packages:
2626
```sh
2727
sudo dnf -y install perl gcc
2828
```
29-
- `perl` is required to build openssl-sys
29+
- `perl` is required to build `openssl-sys`
3030
- openSUSE Thumbleweed/Leap
3131
```
3232
sudo zypper install -y gcc ninja make
@@ -125,7 +125,7 @@ Options:
125125
> **Note**
126126
>
127127
> #### GitHub API
128-
> During the installation, we do a few GitHub queries, [which has some limits](https://docs.github.com/en/rest/overview/resources-in-the-rest-api?apiVersion=2022-11-28#rate-limiting). Our number of queries should not hit the limits unless you are running `espup install` command numerous times in a short span of time. We recommend setting the [`GITHUB_TOKEN` environment variable](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret) when using `espup` in CI, if you want to use `espup` on CI, recommend using it via the [`xtensa-toolchain` action](https://github.com/esp-rs/xtensa-toolchain/), and making sure `GITHUB_TOKEN` is not set when using it on a host machine. See https://github.com/esp-rs/xtensa-toolchain/issues/15 for more details on this.
128+
> During the installation process, several GitHub queries are made, [which are subject to certain limits](https://docs.github.com/en/rest/overview/resources-in-the-rest-api?apiVersion=2022-11-28#rate-limiting). Our number of queries should not hit the limits unless you are running `espup install` command numerous times in a short span of time. We recommend setting the [`GITHUB_TOKEN` environment variable](https://docs.github.com/en/actions/security-guides/automatic-token-authentication#about-the-github_token-secret) when using `espup` in CI, if you want to use `espup` on CI, recommend using it via the [`xtensa-toolchain` action](https://github.com/esp-rs/xtensa-toolchain/), and making sure `GITHUB_TOKEN` is not set when using it on a host machine. See https://github.com/esp-rs/xtensa-toolchain/issues/15 for more details on this.
129129
130130
```
131131
Usage: espup install [OPTIONS]

0 commit comments

Comments
 (0)