Skip to content

Commit

Permalink
Update contribution doc for MacOS envs (#1223)
Browse files Browse the repository at this point in the history
* Fix documentation command typo

* Add colima info and useful commands
  • Loading branch information
karlaspuldaro committed Feb 26, 2024
1 parent 3c90230 commit 2a84131
Showing 1 changed file with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,15 +79,30 @@ You'll need to install these tools on your development environment:
Note: Installing the `pip` and `venv` python libraries will also be useful

#### For non-Linux users
To simplify the steps required to build and deploy quantum-serverless, we recommend the use of virtual machines for runtime containers.

If you are on a Windows machine, it is recommended to use [Windows Subsystem for Linux](https://learn.microsoft.com/en-us/windows/wsl/install).

If you are on a Mac machine, it is recommended to use [Colima](https://github.com/abiosoft/colima), which can be set up as follows:
If you are on a Mac machine, it is recommended to use [Colima](https://github.com/abiosoft/colima) to run docker and kubernetes container environments. It automatically installs [`containerd`](https://github.com/containerd/containerd) runtime and provides support for `nerdctl`, a CLI tool for `containerd`. Colima can be set up as follows:

```bash
brew install colima
brew install docker
colima start -- cpu 4 --memory 8
colima start --cpu 4 --memory 8
```
To check if colima is running:
```bash
colima status
```

To list running containers:
```bash
nerdctl ps -a
```

To list container images:
```bash
nerdctl images
```

### Deciding what to work on
Expand Down

0 comments on commit 2a84131

Please sign in to comment.