Skip to content

docs: readme update #51

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

Merged
vsimon merged 1 commit into from
May 15, 2026
+5 −5
Merged

docs: readme update #51

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
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ Declarative macOS system settings - define your preferences in YAML and apply th

## Install

```
```sh
brew install vsimon/tap/macform
```

## Quick start

```bash
```sh
# Snapshot current settings into a spec file
macform generate

Expand All @@ -35,16 +35,16 @@ Requires macOS Tahoe or later.

Requires [mise](https://mise.jdx.dev) (`brew install mise`)

Run to get started:
To get started:

```bash
```sh
mise install
mise build
```

Run tests:

```bash
```sh
mise test
```

Expand Down