From 3d8451a13361230d53308da54d71a2eddb364472 Mon Sep 17 00:00:00 2001 From: bring42 <63049750+bring42@users.noreply.github.com> Date: Wed, 17 Jan 2024 11:40:29 +0100 Subject: [PATCH] Docs for cli on MacOS (#190) MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: “bring42” <“Benno657@student.liu.se”> --- docs/cli.md | 16 +++++++++++----- 1 file changed, 11 insertions(+), 5 deletions(-) diff --git a/docs/cli.md b/docs/cli.md index cdfa83f0..03e6ee1c 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -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. @@ -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`)