Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

README: add macOS steps #669

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

README: add macOS steps #669

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -249,6 +249,10 @@ huggingface

so if you like this tool, give some of these repos a :star:, and hey, give us a :star: too while you are at it.

## macOS

To run ramalama project on macOS, [follow our dedicated guide](docs/README-macOS.md)

## Community

[`Matrix`](https://matrix.to/#/#ramalama:fedoraproject.org)
Expand Down
15 changes: 15 additions & 0 deletions docs/README-macOS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
This README provides a step-by-step guide on how to run ramalama on macOS.

```bash
brew install go
brew install podman
Copy link
Collaborator

@ericcurtin ericcurtin Jan 30, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It can be much simpler than this, install podman cli or podman desktop for macOS here:

https://podman.io/

this official installer comes with krunkit for AI acceleration, etc. I'd avoid recommending brew podman, it's not as good.

Change the hypervisor to krunkit. Run podman machine init, podman machine start, etc.

Then run:

curl -fsSL https://raw.githubusercontent.com/containers/ramalama/s/install.sh | bash

The "curl" command is the only one you strictly need if you don't want to use containers.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Agreed. brew install podman is not recomended. Link to installation of podman desktop and recommend libkrun

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also podman should be optional, Docker is an option.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sometimes I wish RamaLama was just part of podman desktop and podman cli installers. It's like 10 python files? Super tiny...

go install github.com/cpuguy83/go-md2man/v2@latest
python3 -m venv ~/.venvs/ramalama
source ~/.venvs/ramalama/bin/activate
pip install argcomplete
sudo make install
podman machine init
podman machine start
sudo make build
```

Loading