Skip to content

Commit 082b041

Browse files
Update README with installation and usage steps
1 parent 2fdf315 commit 082b041

File tree

1 file changed

+12
-5
lines changed

1 file changed

+12
-5
lines changed

README.md

Lines changed: 12 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
# Demo
22

3+
## STEP 1: Install Anaconda
4+
Download the executable from [this link](https://www.anaconda.com/download) then follow the instructions there to install Anaconda.
5+
36
## STEP 1: Create a new Conda environment
47
In an Anaconda terminal, run `conda create -n "mousearm-test python=3.11 -y"` or any environment name.
58
Activate the environment with `conda activate mousearm-test`.
@@ -8,7 +11,11 @@ Activate the environment with `conda activate mousearm-test`.
811
**Windows/Linux**: `conda install -c opensim-org opensim`.
912
**macOS (Apple Silicon)**: `CONDA_SUBDIR=osx-64 conda install -c opensim-org opensim`.
1013

11-
## STEP 3: Clone this git repo and install the library
14+
## STEP 3: Go to your Documents folder
15+
**Windows**: `cd %USERPROFILE%\Documents`.
16+
**Linux/macOS**: `cd ~/Documents`.
17+
18+
## STEP 4: Clone this git repo and install the library
1219
Run the following in the Anaconda terminal:
1320
```
1421
# Using SSH:
@@ -22,16 +29,16 @@ pip install uv'
2229
2330
uv pip install -e .
2431
```
25-
## STEP 4: Run the demo
26-
In a new anaconda terminal, cd to the parent directory of the cloned repo. Then, run:
32+
## STEP 5: Run the demo
33+
To do this, run:
2734
```
28-
cd mousearm/mousearm/Demo
35+
cd mousearm/Demo
2936
python demo.py
3037
```
3138

3239
# Sample Usage
3340

34-
## STEP 4: Place your data folder anywhere with the following format (any number of reachsets)
41+
## STEP 5: Place your data folder anywhere with the following format (any number of reachsets)
3542
```
3643
Data/
3744
├── reachset_1/

0 commit comments

Comments
 (0)