README: add macOS steps

[dougsland]

Let's make user live easier to join the ramalama club.

Summary by Sourcery

Add instructions for running ramalama on macOS.

New Features:

• Allow users to run ramalama on macOS.

Documentation:

• Document the steps required to run ramalama on macOS.

[sourcery-ai]

Reviewer's Guide by Sourcery

This pull request adds a guide for running the ramalama project on macOS. It includes instructions for installing necessary tools and setting up the environment.

Flow diagram for macOS installation steps

flowchart TD
    A[Start Installation] --> B[Install Dependencies]
    B --> C[Install Go]
    B --> D[Install Podman]
    B --> E[Install go-md2man]
    C & D & E --> F[Setup Python Environment]
    F --> G[Create Virtual Environment]
    G --> H[Activate Virtual Environment]
    H --> I[Install argcomplete]
    I --> J[Run make install]
    J --> K[Setup Podman]
    K --> L[Initialize Podman machine]
    L --> M[Start Podman machine]
    M --> N[Build Project]
    N --> O[Installation Complete]

Loading

File-Level Changes

Change	Details	Files
Added a macOS section to the main README.	Added a macOS section with a link to the dedicated guide.	README.md
Created a dedicated guide for macOS users.	Added instructions for installing go, podman, and go-md2man. Added instructions for creating and activating a virtual environment. Added instructions for installing argcomplete. Added instructions for running make install, podman machine init, podman machine start, and make build.	docs/README-macOS.md

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!
• Generate a plan of action for an issue: Comment @sourcery-ai plan on
  an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @dougsland - I've reviewed your changes - here's some feedback:

Overall Comments:

• The installation steps appear to be in a suboptimal order - 'sudo make install' should typically come after 'sudo make build'. Consider reordering these steps.
• Consider adding prerequisites and system requirements to the macOS guide (e.g., minimum macOS version, required disk space, etc).

Here's what I looked at during the review

• 🟢 General issues: all looks good
• 🟢 Security: all looks good
• 🟢 Testing: all looks good
• 🟢 Complexity: all looks good
• 🟢 Documentation: all looks good

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[ericcurtin]

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.

[rhatdan]

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

[rhatdan]

Also podman should be optional, Docker is an option.

[ericcurtin]

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