homebrew
This commit is contained in:
20
README.md
20
README.md
@ -3,11 +3,27 @@
|
||||
CLI tool for updating and launching [Project Epoch](https://www.project-epoch.net/) on Linux & macOS.
|
||||
|
||||
## Setup
|
||||
For Linux, a `wine` prefix with `dxvk` installed is sufficient, or you can use something like Lutris or faugus-launcher without the launcher functionality in `epochcli`.
|
||||
|
||||
Installing is different between Linux and macO S
|
||||
|
||||
### Linux
|
||||
A `wine` prefix with `dxvk` installed is sufficient, or you can use something like Lutris or faugus-launcher without the launcher functionality in `epochcli`.
|
||||
|
||||
Download and extract the latest binary from the [releases](https://git.burkey.co/eburk/epochcli/releases) page, build from source yourself, or use homebrew in the macOS instructions below
|
||||
|
||||
### macOS
|
||||
|
||||
For macOS, I've found the best way to run the client is in a Parallels Win 11 VM. Kegworks, Codeweavers, etc crash when the game starts up and I have not found a good solution so far.
|
||||
|
||||
1. Download and extract the latest binary from the [releases](https://git.burkey.co/eburk/epochcli/releases) page.
|
||||
You can easily install with homebrew or build from source yourself. For homebrew, do the following:
|
||||
|
||||
```shell
|
||||
brew tap eburk/epochcli https://git.burkey.co/eburk/epochcli
|
||||
brew install --HEAD epochcli
|
||||
```
|
||||
|
||||
### First Run
|
||||
|
||||
2. Run `epochcli`. You will be taken through a setup process that configures the program and creates a config file at `$HOME/.config/epochcli/config.toml`
|
||||
3. You can now use `epochcli` as just a standalone updater or also a launcher based on your configuration. You can always run `epochcli -c` to redo the configuration or edit the config file manually
|
||||
|
||||
|
Reference in New Issue
Block a user