Files
golang-repo-template/README.md
2023-02-18 15:36:40 +01:00

57 lines
4.4 KiB
Markdown

# Go repo template
- You can use this template to create a new golang repo.
- Start by forking this template repo to your own github page.
- Then create a new repo on your github page, using this repo template.
- __Note:__ This template is not a golang project, it is a template for creating a new golang repo.</br>
Also the README file here only works with ___public___ repos.
After creating a new repo, you will need to change the README file to suit your needs.</br>
All badges with repo references must be updated to point to your new repo. Otherwise you'll see info from this template repo instead.</br>
If you create a ___private___ repo, you will need to change the README file to suit your needs.</br>
Badges referencing a repo can only be seen on ___public___ repos. ___Private___ repos are not visible to the badge service.
- __Note:__ The wakatime badge requires a wakatime account.
- After creating the new repo, you can replace the GPLv3 license with another license that suits you, if required.
- Then start your golang project with go mod init.
Example Go project repo based on this template [Test Go project](https://GitHub.com/Lerking/test-go-project)
[![GitHub forks](https://img.shields.io/github/forks/Lerking/golang-repo-template.svg?style=social&label=Fork&maxAge=2592000)](https://GitHub.com/Lerking/golang-repo-template/forks/)
[![GitHub stars](https://img.shields.io/github/stars/Lerking/golang-repo-template.svg?style=social&label=Star&maxAge=2592000)](https://GitHub.com/Lerking/golang-repo-template/stargazers/)
[![GitHub watchers](https://img.shields.io/github/watchers/Lerking/golang-repo-template.svg?style=social&label=Watch&maxAge=2592000)](https://GitHub.com/Lerking/golang-repo-template/watchers/)
[![forthebadge made-with-go](http://ForTheBadge.com/images/badges/made-with-go.svg)](https://go.dev/)
![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/Lerking/golang-repo-template)
[![GitHub license](https://img.shields.io/github/license/Lerking/golang-repo-template.svg)](https://github.com/Lerking/golang-repo-template/blob/master/LICENSE)
[![GitHub version](https://badge.fury.io/gh/Lerking-golang-repo-template.svg)](https://github.com/Lerking/golang-repo-template)
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://GitHub.com/Lerking/golang-repo-template.github.io/graphs/commit-activity)
[![GitHub contributors](https://img.shields.io/github/contributors/Lerking/golang-repo-template.svg)](https://GitHub.com/Lerking/golang-repo-template/graphs/contributors/)
![example workflow](https://github.com/Lerking/golang-repo-template/actions/workflows/go.yml/badge.svg)
## Please join the discusion panel</br>
![GitHub Discussions](https://img.shields.io/github/discussions/Lerking/golang-repo-template)
![GitHub last commit](https://img.shields.io/github/last-commit/Lerking/golang-repo-template)
![GitHub commit activity](https://img.shields.io/github/commit-activity/m/Lerking/golang-repo-template)
[![Github file count](https://img.shields.io/github/directory-file-count/Lerking/golang-repo-template)]()
![GitHub issues](https://img.shields.io/github/issues-raw/Lerking/golang-repo-template)
![GitHub closed issues](https://img.shields.io/github/issues-closed-raw/Lerking/golang-repo-template)
[![Percentage of issues still open](http://isitmaintained.com/badge/open/Lerking/golang-repo-template.svg)](http://isitmaintained.com/project/Lerking/golang-repo-template "Percentage of issues still open")
[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/Lerking/golang-repo-template.svg)](http://isitmaintained.com/project/Lerking/golang-repo-template "Average time to resolve an issue")
![GitHub open pull requests](https://img.shields.io/github/issues-pr-raw/Lerking/golang-repo-template)
![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed-raw/Lerking/golang-repo-template)
Coding time for this project.</br>
[![wakatime](https://wakatime.com/badge/user/d43f2852-fd6f-45b4-b713-558ad18204d4/project/3bf1925d-c859-44af-b2e6-3f53d804d3a0.svg)](https://wakatime.com/badge/user/d43f2852-fd6f-45b4-b713-558ad18204d4/project/3bf1925d-c859-44af-b2e6-3f53d804d3a0)
See the wiki for usage and examples.
[golang-repo-template wiki page](https://github.com/Lerking/golang-repo-template/wiki)
Visitors since repo creation.</br>
![Visitor Badge](https://visitor-badge.laobi.icu/badge?page_id=Lerking.golang-repo-template)