template / commit
Minor documentation changes.
README.md | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 5be8c33..9cb0997 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,7 @@ template ## Description -This CLI creates files and folders with generated templated names, for example `2022-09-26-fhl-2023.md` (generator on September 26, 2023, with the project name "fhl-2023"). +This CLI creates files and folders with generated templated names, for example `2022-09-26-fhl-2023.md` (generated 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 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. @@ -64,13 +64,18 @@ This will cause VSCode to open the `~\DailyNotes` folder as a workspace, and the The above example also uses the [`snakecase`](https://github.com/Masterminds/sprig/blob/master/docs/strings.md#user-content-snakecase) template function. This is one of the [sprig template functions](https://github.com/Masterminds/sprig/blob/master/docs/index.md) that are exposed by template. +Note that user profiles are combined with the default ones. +This is so you can run `template reset` to reset `~/.template.yaml`, but keep your local profiles/changes as-is. + ## 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 application is a single executable, there are no special requirements. + +Building 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 default profiles use [Visual Studio Code](https://code.visualstudio.com/). +The default profiles use [Visual Studio Code](https://code.visualstudio.com/) to open the generated files. ## Package and installation