wneessen/apg-go
1
1
Fork 0
mirror of https://github.com/wneessen/apg-go.git synced 2024-11-09 15:52:54 +01:00
Code Issues Projects Releases Packages Wiki Activity

Add Go install instructions to README

Browse source 
This commit includes detailed Go install instructions for the apg-go project into the README.md. The instructions verify Go version, describe the installation of the latest version and retrieval of a specific version, and also details on how to execute apg-go. This additional information allows users with Go installed in their systems to easily use and test the apg-go project.
This commit is contained in:
Winni Neessen 2024-03-26 09:52:39 +01:00
parent 86a06adc34
commit ab05d338e8
Signed by: wneessen
GPG key ID: 385AC9889632126E
1 changed files with 30 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -72,6 +72,36 @@ There is a ready-to-use Docker image hosted on Github.
$ docker run ghcr.io/wneessen/apg-go:main
```
### Go install
apg-go can be installed using the `go install` command if you have Go installed on your system. This requires
that you have Go installed on your system and that your Go version matches or is higher than the version
required in `go.mod`. You can install various versions using `go install`.
* Verify your Go version
```shell
$ go version
go version go1.22.1 linux/amd64
```
**Note: Make sure that your Go version matches the requirements of apg-go.**
* Install the latest version of apg-go
```shell
$ go install github.com/wneessen/apg-go/cmd/apg@latest
```
The `latest` tag will always install the latest release. If you want to run a different version you can replace
the `latest` with the requested version (i. e. `v1.1.0`). Alternatively if you want to test the latest code, not
fully released code from the main branch, you can replace `latest` with `main`.
* Execute apg-go
Once the `go install` command completed without errors, your apg-go binary will be installed into your Go project
workspace or your `$GOPATH/bin` directory (i. e. `/home/ttester/go/bin`). If this directory is
part of your `$PATH` environment, you can just execute it via the `apg` command, otherwise you'll need to
specify the full path: `/home/ttester/go/bin/apg`.
```shell
$ /home/ttester/go/bin/apg -v
apg-go // A "Automated Password Generator"-clone v1.2.0
OS: linux // Arch: amd64
(C) 2021-2024 by Winni Neessen
```
### Binary releases/Packages
On the [Github release page](https://github.com/wneessen/apg-go/releases) you will always find pre-build binaries
for all supported OS and architectures. You will also find pre-built packages for the most common Linux distributions.