Skip to content

Commit

Permalink
docs: update Readme for macos support
Browse files Browse the repository at this point in the history
  • Loading branch information
dancergraham committed Jul 25, 2024
1 parent 58889d3 commit 0e20fb0
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,21 +68,21 @@ translation_x = scan_0["pose"]["translation"]["x"]

## Installation

If you're on linux or Windows, a wheel should be available.
On linux Windows or macos:

`python -m pip install pye57`

## Building from source
## Building from source (for developers)

### Cloning the repository and required submodules
### Cloning the repository with required submodule

Clone a new repository along with the required submodules
Clone a new repository along with the libe57Format submodule

`git clone https://github.com/davidcaron/pye57.git --recursive`

If the repository has already been previously cloned, but without the --recursive flag

```
```Bash
cd pye57 # go to the cloned repository
git submodule init # this will initialise the submodules in the repository
git submodule update # this will update the submodules in the repository
Expand All @@ -102,7 +102,7 @@ To get xerces-c, you can either build from source or if you're using conda:

### Run `pip install` from the repo source

```
```Bash
cd pye57
python -m pip install .
```
Expand All @@ -111,6 +111,6 @@ python -m pip install .

Use pip again

```
```Bash
python -m pip uninstall pye57
```

0 comments on commit 0e20fb0

Please sign in to comment.