diff --git a/README.md b/README.md index f727dc4..9f1535d 100644 --- a/README.md +++ b/README.md @@ -4,28 +4,31 @@ CLI tool for updating and launching [Project Epoch](https://www.project-epoch.ne ## Setup -Installing is different between Linux and macO S +Installing is different between Linux and macOS ### 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`. +A `wine` prefix with `dxvk` installed is sufficient, or you can use something like Lutris or faugus-launcher and just use `epochcli` for updating. 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. +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. Any suggestions would be welcome, see my contact information below. 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 + +# To update +brew upgrade epochcli --fetch-HEAD ``` -### First Run +## 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 +1. 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` +2. 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 ## Usage ```