diff --git a/Makefile b/Makefile index c13fa13..f01784d 100644 --- a/Makefile +++ b/Makefile @@ -170,7 +170,14 @@ install-darwin: app-bundle install-unix: build @echo "Installing on $(shell uname)..." @echo "Installing binary to /usr/local/bin..." - @sudo install -m 755 out/$(APP_NAME) /usr/local/bin/ + @if command -v sudo >/dev/null 2>&1; then \ + sudo install -m 755 out/$(APP_NAME) /usr/local/bin/; \ + elif command -v doas >/dev/null 2>&1; then \ + doas install -m 755 out/$(APP_NAME) /usr/local/bin/; \ + else \ + echo "Error: Neither sudo nor doas found. Please install the binary manually."; \ + exit 1; \ + fi @echo "Installation complete! $(APP_NAME) has been installed to /usr/local/bin" # Install on Windows diff --git a/README.md b/README.md index 3027de4..40da8de 100644 --- a/README.md +++ b/README.md @@ -12,24 +12,6 @@ The only PR tracker that honks at you when you're the bottleneck. Now shipping w Lives in your menubar like a tiny waterfowl of productivity shame, watching your GitHub PRs and making aggressive bird sounds when you're blocking someone's code from seeing the light of production. ![Review Goose Screenshot](media/screenshot.png) - -## What It Does - -- **Honks** when you're blocking someone's PR (authentic goose noises included) -- **Jet sounds** when your own PR is ready for the next stage -- **Smart turn-based assignment** - knows who is blocking a PR, knows when tests are failing, etc. -- **Auto-start** on login (macOS) -- **Auto-open** incoming PRs in your browser (off by default, rate-limited) -- **Org Filtering** for orgs you may not care about in a home or work context -- **Multi-platform** support for Linux, macOS, Windows, FreeBSD, whatever. - -You can also visit the web-based dashboard at - -## Dependencies - -- [go](https://go.dev/) 1.23.4 or higher -- [gh](https://cli.github.com/), AKA the GitHub command-line utility - ## macOS Quick Start ⚡ (Get Honked At) Install dependencies: @@ -53,7 +35,19 @@ cd goose && make run This will will cause the goose to implant itself into `/Applications/Review Goose.app` for future invocations. To be persistently annoyed every time you login, click the `Start at Login` menu item. -### Using a fine-grained access token +## Linux/BSD/Windows Quick Start + +1. Install the GitHub CLI and Go via your platforms recommended methods +2. Compile and install Goose: + +```bash +go install github.com/codeGROOVE-dev/goose/cmd/goose@latest +``` + +3. Copy goose from $HOME/go/bin to wherever you prefer +4. Add goose to your auto-login so you never foget about PRs again + +## Using a fine-grained access token If you want more control over which repositories the goose can access, you can use a [fine-grained personal access token](https://github.com/settings/personal-access-tokens/new) with the following permissions: