Skip to content

Commit c03bdbe

Browse files
threexcluhenry
andauthored
README: add simple usage example, rename section (#2497)
* README: add simple usage example, rename section Copy the basic pip index example from the "Install" page, so that users landing on the python-wheels repository immediately have a sense of how to actually use what RISE is building. Co-authored-by: Ludovic Henry <git@ludovic.dev> Signed-off-by: Trevor Gamblin <tgamblin@baylibre.com>
1 parent 2a934e1 commit c03bdbe

1 file changed

Lines changed: 14 additions & 1 deletion

File tree

‎README.md‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,20 @@ repository for projects where upstream are not yet ready or able to perform buil
99

1010
[RISE](https://riseproject.dev) is a collaborative, industry-led initiative under the Linux Foundation that accelerates open-source software development for the RISC-V architecture.
1111

12-
## Documentation
12+
## Usage
13+
14+
Installing Python wheels from the RISE registry is as easy as:
15+
16+
```bash
17+
python -m pip install --upgrade pip
18+
```
19+
20+
and then pass the `--index-url` option to the install command to tell pip to
21+
pull packages from the RISE package index, e.g.,
22+
23+
```bash
24+
python -m pip install scipy --extra-index-url https://pypi.riseproject.dev/simple/ --prefer-binary
25+
```
1326

1427
Find complete documentation on [the python-wheels website](https://pypi.riseproject.dev/)
1528

0 commit comments

Comments
 (0)