Skip to content

Commit 5a59524

Browse files
Update installation instructions in README.md
1 parent 81cedf2 commit 5a59524

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

README.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,33 @@ AMP-RSL-RL is a reinforcement learning library that extends the Proximal Policy
66

77
## 📦 Installation
88

9-
First, clone the repository and install it using:
9+
The repository is available on PyPI under the package name **amp-rl-rsl**. You can install it directly using pip:
1010

1111
```bash
12-
pip install .
12+
pip install amp-rl-rsl
1313
```
1414

15-
Or in editable/development mode:
15+
Alternatively, if you prefer to clone the repository and install it locally, follow these steps:
16+
17+
1. Clone the repository:
18+
```bash
19+
git clone https://github.com/<your-username>/amp_rsl_rl.git
20+
cd amp_rsl_rl
21+
```
22+
23+
2. Install the package:
24+
```bash
25+
pip install .
26+
```
27+
28+
For editable/development mode:
1629

1730
```bash
1831
pip install -e .
1932
```
2033

21-
If you want to run the examples, please install it with
34+
If you want to run the examples, please install with:
35+
2236
```bash
2337
pip install .[examples]
2438
```
@@ -30,7 +44,7 @@ The required dependencies include:
3044
- `torch`
3145
- `rsl-rl-lib`
3246

33-
These will be automatically installed via `pip`.
47+
These will be automatically installed via pip.
3448

3549
---
3650

0 commit comments

Comments
 (0)