Skip to content

Commit

Permalink
Docs for cli on MacOS
Browse files Browse the repository at this point in the history
  • Loading branch information
“bring42” authored and “bring42” committed Dec 21, 2023
1 parent fefcde5 commit af07b54
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,13 +102,23 @@ To run again after installing, just do the following:

2. Run the CLI with `python chameleon_cli_main.py`

### Linux
### MacOS

Requires [Homebrew](https://brew.sh/) to be installed.
- If you don't have Homebrew installed on your macOS, open the Terminal and run:
`/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"`

See Linux/Macos instructions below for the rest.

### Linux / MacOS

Install the dependencies
- Ubuntu / Debian:
`sudo apt install git cmake build-essential python3-venv`
- Arch:
`sudo pacman -S git cmake base-devel python3`
- MacOS:
`brew install git cmake python3`

Python 3.9 or above is required.

Expand Down Expand Up @@ -145,10 +155,6 @@ python3 chameleon_cli_main.py
deactivate
```

### MacOS

*Coming Soon*

## Usage

When in the CLI, plug in your Chameleon and connect with `hw connect`. If autodetection fails, get the Serial Port used by your Chameleon and run `hw connect -p COM11` (Replace `COM11` with your serial port, on Linux it may be `/dev/ttyACM0`)
Expand Down

0 comments on commit af07b54

Please sign in to comment.