diff --git a/Formula/epochcli.rb b/Formula/epochcli.rb index 429766a..83b6181 100644 --- a/Formula/epochcli.rb +++ b/Formula/epochcli.rb @@ -1,19 +1,16 @@ class Epochcli < Formula desc "Updater and Launcher for Epoch" homepage "https://git.burkey.co/eburk/epochcli/src/branch/master" - url "https://git.burkey.co/eburk/epochcli/archive/0.0.2.tar.gz" - sha256 "192ae687256a33468e97c7116177b65fb42b42a66138f61f24b93b76f4048f1c" license "ISC" head "https://git.burkey.co/eburk/epochcli.git", branch: "master" - livecheck do - url :stable - end - depends_on "go" => :build def install - system "go", "build" - bin.install "epochcli" + system "go", "build", *std_go_args(ldflags: "-s -w") + end + + test do + assert_match "Epochcli Help:", shell_output("#{bin}/epochcli -h") end end diff --git a/README.md b/README.md index c7b5513..f727dc4 100644 --- a/README.md +++ b/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 diff --git a/main.go b/main.go index b2fff96..7c9fcaa 100644 --- a/main.go +++ b/main.go @@ -36,6 +36,7 @@ func main() { if helpFlag { flag.CommandLine.SetOutput(os.Stdout) + fmt.Println("Epochcli Help:") flag.PrintDefaults() os.Exit(0) }