template / commit
Added some more info to the readme.
README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2f319fb..aeb9ff8 100644 --- a/README.md +++ b/README.md @@ -9,7 +9,7 @@ template This CLI creates files and folders with generated names, for example `2022-09-26-fhl-2023.md` (generator on September 26, 2023, with the project name "fhl-2023"). 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. -This is a hackathon project that I used to learn Go (golang). +This started as a hackathon project that I used to learn Go (golang) and to automate a repetitive task: creation of time-stamped files and folders. This project is mainly a CLI app written in Go, but it's also a Go module, so it can be used as a dependency. I'm not entirely sure why anyone would want to use this module instead of the CLI, but it's there. @@ -65,9 +65,9 @@ This will cause VSCode to open the `~\DailyNotes` folder as a workspace, and the The application requires [go](https://en.wikipedia.org/wiki/Go_(programming_language)). You can download the installer [here](https://go.dev/doc/install). -The build is managed by [make](https://www.gnu.org/software/make/). +The build is managed by [make](https://www.gnu.org/software/make/) and uses [PowerShell Core](https://github.com/PowerShell/PowerShell). -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. +The default profiles use [PowerShell Core](https://github.com/PowerShell/PowerShell) and [Visual Studio Code](https://code.visualstudio.com/). ## Package and installation @@ -116,6 +116,8 @@ ln -s ~/Dropbox/Work ~/Work A simple way to get started is to load this directory in VSCode and debug the project using one of the prepared launch tasks. Use command `View: Show Run and Debug` to display the launch configs, then pick one and press "Start Debugging" button. +The following command will build the package, test it, and then install it. I use this approach, but that's because I use `template xyz` multiple times a day, and find it helpful to be using the latest version. + ## Support For anything, open an issue in this repo.