README
¶
go4hackers is a starter template typically made for create open-source tool in Go.
How • Install • Documentation •
How to use
go4hackers -h
This will display help for the tool. Here are all the switches it supports.
Install
If you have a Go environment ready to go (at least go 1.19), it's as easy as:
go install github.com/LeoFVO/go4hackers@latest
PS: You need at least go 1.19 to compile go4hackers.
Docker
```bash docker pull ghcr.io/leofvo/go4hackers:latest docker run go4hackers:latest ```Binary Releases
We are now shipping binaries for each of the releases so that you don't even have to build them yourself! How wonderful is that!If you're stupid enough to trust binaries that I've put together, you can download them from the releases page.
Build from source
Prerequisites
Since this tool is written in Go you need to install the Go language/compiler/etc. Full details of installation and set up can be found on the Go language website. Once installed you have two options. You need at least go 1.19 to compile go4hackers.
Clone the repository
git clone [email protected]:LeoFVO/go4hackers.git
Compiling
go4hackers has external dependencies, and so they need to be pulled in first:
go get && go build
This will create a go4hackers binary for you. If you want to install it in the $GOPATH/bin folder you can run:
go install
Setup
Documentation
The documentation is available at https://leofvo.github.io/go4hackers/.
In order to deploy documentation for your project, you need to allow github actions to deploy github pages. To do so, go to your repository settings > Pages, and in the Build and deployment section, select Github Actions as the source.
License
go4hackers is distributed under MIT License
Documentation
¶
There is no documentation for this package.
Source Files
Directories