template / commit
Expanded the readme a bit.
README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5013665..7c80993 100644 --- a/README.md +++ b/README.md @@ -10,6 +10,12 @@ This is a hackathon project that I used to learn Go (golang). This CLI creates files and folders with generated names. It's also possible to control the contents of the files: you can specify a template file or an inline template to set the file contents. +## Requirements + +The application requires [go](https://en.wikipedia.org/wiki/Go_(programming_language)). You can download the installer [here](https://go.dev/doc/install). + +The default profiles use [PowerShell Core](https://github.com/PowerShell/PowerShell) and [Visual Studio Code](https://code.visualstudio.com/). You'll need to install both tools to use the default profiles. + ## Running in development - `go run .` - uses default profile "note" to create a date-stamped MD file in current folder @@ -30,9 +36,8 @@ It's also possible to control the contents of the files: you can specify a templ Here is a way to install the app, clear out the local config, and run the app: -``` -go install; rm ~\.template.yaml -ErrorAction SilentlyContinue ; template -``` +1. Open project in VSCode +2. Run the "Clean install" task from "Run and Debug" view ## Integrate with your tools