Skip to content

Commit

Permalink
Update installation instructions to include Homebrew use on Linux, an…
Browse files Browse the repository at this point in the history
…d don't automatically update the Homebrew formula on release (#101)

* Don't automatically update Homebrew formula on release~

* Document support for installing from Homebrew on Linux
  • Loading branch information
timrogers authored Oct 11, 2024
1 parent 997e5e1 commit 4beaaf1
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 21 deletions.
18 changes: 0 additions & 18 deletions .github/workflows/build_and_release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -214,24 +214,6 @@ jobs:
litra_${{ steps.sanitise_ref.outputs.value }}_darwin-arm64
litra_${{ steps.sanitise_ref.outputs.value }}_linux-amd64
litra_${{ steps.sanitise_ref.outputs.value }}_darwin-universal
publish_on_homebrew:
name: Publish release on Homebrew
runs-on: ubuntu-latest
needs: create_github_release
if: startsWith(github.event.ref, 'refs/tags/v')
steps:
- name: Get released version
id: get_version
run: echo ::set-output name=VERSION::${GITHUB_REF#refs/tags/}
- uses: mislav/bump-homebrew-formula-action@v3
with:
formula-name: litra
download-url: https://github.com/timrogers/litra-rs/releases/download/${{ steps.get_version.outputs.VERSION }}/litra_${{ steps.get_version.outputs.VERSION }}_darwin-universal
homebrew-tap: timrogers/homebrew-tap
push-to: timrogers/homebrew-tap
create-pullrequest: true
env:
COMMITTER_TOKEN: ${{ secrets.COMMITTER_TOKEN }}
cargo_publish:
name: Publish with Cargo to Crates.io
runs-on: ubuntu-latest
Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,18 +26,18 @@ The following Logitech Litra devices, __connected via USB__, are supported:

## Installation

### macOS with [Homebrew](https://brew.sh/)
### macOS or Linux via [Homebrew](https://brew.sh/)

1. Install the latest version by running `brew tap timrogers/tap && brew install litra`.
1. Run `litra --help` to check that everything is working and see the available commands.

### All other platforms (using Cargo)
### macOS, Linux or Windows via [Cargo](https://doc.rust-lang.org/cargo/), Rust's package manager

1. Install [Rust](https://www.rust-lang.org/tools/install) on your machine, if it isn't already installed.
1. Install the `litra` crate by running `cargo install litra`.
1. Run `litra --help` to check that everything is working and see the available commands.

### All other platforms (via binary)
### macOS, Linux or Windows via direct binary download

1. Download the [latest release](https://github.com/timrogers/litra-rs/releases/latest) for your platform. macOS, Linux and Windows devices are supported.
2. Add the binary to `$PATH`, so you can execute it from your shell. For the best experience, call it `litra` on macOS and Linux, and `litra.exe` on Windows.
Expand Down

0 comments on commit 4beaaf1

Please sign in to comment.