Improve installation instructions in README (#283)

This commit is contained in:
Omay 2024-04-21 05:44:34 -06:00 committed by GitHub
parent 62e78d40e9
commit 5bb680f266
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -24,7 +24,11 @@ Join my Discord server if you need help [here](https://discord.gg/Csh8zbbhCt)!
- Creation of remote file metadata from JAR files for CurseForge mods
## Installation
Prebuilt binaries are available from [GitHub Actions](https://github.com/packwiz/packwiz/actions) - the UI is a bit terrible, but essentially select the top build, then download the artifact ZIP for your system at the bottom of the page. To run the executable, add the folder where you downloaded it to your PATH environment variable ([see tutorial for Windows here](https://www.howtogeek.com/118594/how-to-edit-your-system-path-for-easy-command-line-access/)) or move it to where you want to use it.
Prebuilt binaries are available from [GitHub Actions](https://github.com/packwiz/packwiz/actions) - the UI is a bit terrible, but essentially select the top build, then download the artifact ZIP for your system at the bottom of the page.
Another option is to use [nightly.link](https://nightly.link/packwiz/packwiz/workflows/go/main). Just go to the page, and download the artifact for your system.
To run the executable, first extract it, then add the folder where you extracted it to your PATH environment variable ([see tutorial for Windows here](https://www.howtogeek.com/118594/how-to-edit-your-system-path-for-easy-command-line-access/)) or move it to where you want to use it.
In future I will have a lot more installation options, but you can also compile from source:
@ -32,4 +36,4 @@ In future I will have a lot more installation options, but you can also compile
2. Run `go install github.com/packwiz/packwiz@latest`. Be patient, it has to download and compile dependencies as well!
## Documentation
See https://packwiz.infra.link/ for the full packwiz documentation!
See https://packwiz.infra.link/ for the full packwiz documentation!