README

Author: jessp01

README.md

@@ -1,17 +1,38 @@
-# GRT 
+# GRT (GO Repo Template)
 
 [![CI][badge-build]][build]
 [![GoDoc][go-docs-badge]][go-docs]
 [![GoReportCard][go-report-card-badge]][go-report-card]
 [![License][badge-license]][license]
 
-GO Repo Template
-
 ## Motivation
 
+This repo aims to save some boostrapping time when creating a new GO repo.
+
 ## Contents
+- [.pre-commit-config.yaml](.pre-commit-config.yaml): a set of pre-commit hooks relevant to GO code
+- [.goreleaser.yaml](.goreleaser.yaml): [goreleaser](https://goreleaser.com/quick-start) configuration file
+- [.github/workflows/go.yml](.github/workflows/go.yml): GH action for post push and pull request testing
+- [.github/workflows/release.yml](.github/workflows/release.yml): GH action to trigger upon tag creation
+
+## Bootstrapping steps
+- Fork this repo
+- Under `https://github.com/YOUR_ORG/grt/settings`, make sure `Template repository` is checked
+- When creating a new GO repo, select `grt` as the `Repository template`
+- Clone the new repo
+- Run `go run cmd/grt.go -i README.tmpl.md -o README.md -r github.com/YOUR_ORG/YOUR_REPO_NAME`
+- Edit README.md and fill in the different sections
+- Set the desired LICENSE (default is AGPLv3)
+
+### pre-commit hooks
+
+### grt.go
+
+### grt_test.go
+
+### cmd/grt.go
 
-## Usage
+### Goreleaser
 
 [license]: ./LICENSE
 [badge-license]: https://img.shields.io/github/license/jessp01/grt.svg

grt.go

@@ -16,7 +16,7 @@ func ReplaceTokens(inputFilePath, outputFilePath, repoHost, repoOrg, repoName, n
 	newRepoHost := parts[0]
 	newRepoOrg := parts[1]
 	newRepoName := parts[2]
-	log.Printf("repoHost: %s, repoOrg: %s, repoName: %s, newRepoHost: %s, newRepoOrg: %s, newRepoName: %s\n", repoHost, repoOrg, repoName, newRepoHost, newRepoOrg, newRepoName)
+	// log.Printf("repoHost: %s, repoOrg: %s, repoName: %s, newRepoHost: %s, newRepoOrg: %s, newRepoName: %s\n", repoHost, repoOrg, repoName, newRepoHost, newRepoOrg, newRepoName)
 	inplace := false
 
 	if outputFilePath == "" {
@@ -35,10 +35,10 @@ func ReplaceTokens(inputFilePath, outputFilePath, repoHost, repoOrg, repoName, n
 
 	if inplace {
 		script.File(outputFilePath).Stdout()
-		log.Printf("Moving %s to %s\n", outputFilePath, inputFilePath)
 		e := os.Rename(outputFilePath, inputFilePath)
 		if e != nil {
 			log.Fatal(e)
 		}
 	}
+	log.Printf("Replaced tokens in %s and created %s\n", inputFilePath, outputFilePath)
 }