From 9a0606ce32f4a2d5dddb0de92adaeb1dc4badd6b Mon Sep 17 00:00:00 2001 From: Evan Burkey Date: Fri, 27 Jun 2025 21:04:45 +0000 Subject: [PATCH] Update README.md --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 5c2477f..1431138 100644 --- a/README.md +++ b/README.md @@ -2,16 +2,12 @@ CLI tool for updating and launching [Project Epoch](https://www.project-epoch.net/) on Windows, Linux and macOS. -## Setup - -### Windows - -Download and extract the latest binary from the [releases](https://git.burkey.co/eburk/epochcli/releases) page or build from source yourself, then copy `epochcli.exe` to a location of your choice. To make it easy, just use the same folder as your Wow game files. +## Installing ### Linux 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 to install. +Download and extract the latest binary from the [releases](https://git.burkey.co/eburk/epochcli/releases) page, build from source yourself, or use homebrew from the macOS instructions to install. ### macOS @@ -27,10 +23,14 @@ brew install --HEAD epochcli brew upgrade epochcli --fetch-HEAD ``` -## First Run +### Windows + +Download and extract the latest binary from the [releases](https://git.burkey.co/eburk/epochcli/releases) page or build from source yourself, then copy `epochcli.exe` to a location of your choice. To make it easy, just use the same folder as your Wow game files. + +## Setup 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 +2. You can now use `epochcli` as a standalone updater, but it can also act as a launcher based on your configuration. You can always run `epochcli -c` to redo the configuration, or edit the config file manually ## Usage ``` @@ -43,4 +43,4 @@ brew upgrade epochcli --fetch-HEAD ## Issues -If you have any issues, [email me](mailto:evan@burkey.co) or ping `Battlehammer` on the Epoch discord \ No newline at end of file +If you have any issues, [email me](mailto:epochcli@burkey.co) or ping `Battlehammer` on the Epoch discord \ No newline at end of file