Skip to content

Latest commit

 

History

History
36 lines (22 loc) · 1.3 KB

README.md

File metadata and controls

36 lines (22 loc) · 1.3 KB
Raw

Golang Template

A Golang project template to save you time and energy.

Licence

Showcase

Golang projects take a long time to setup with all the various files and keeping things uniform across projects. With this Golang template, you can quickly setup boilerplate code and miscellaneous items for your Golang project saving you time and energy so you can get back to coding.

Install

Click the Use this template button at the top of this project's GitHub page, it looks like this:

Showcase

Usage

Easy text replacements

  1. Replace all occurances of USERNAME
  2. Replace all occurances of GO_PROJECT_NAME

File configuration

  1. Change the name of the package folder to match your project name
  2. Configure the go.mod file
  3. Update the author in the LICENSE file
  4. Update variables on top of the Makefile file
  5. Rename the .github/workflows.dist folder to workflows
  6. Update the CHANGELOG.md
  7. Delete this README, update and rename README.dist.md to README.md