template / commit
Minor doc updates.
README.md | 31 +++++++++++++++++++------------ 1 file changed, 19 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 65a0116..91c949b 100644 --- a/README.md +++ b/README.md @@ -62,10 +62,10 @@ Post script had no output This will cause VSCode to open the `~\DailyNotes` folder as a workspace, and the newly-created file `2022-11-20-cool_thought.md` will be opened as well. 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. +This is one of the [sprig template functions](https://github.com/Masterminds/sprig/blob/master/docs/index.md) that are supported by template. File-based profiles (`type: file`) can accept piped input, and this input will be piped to the created file. -In this instance, the profile's file template field is ignored. +In this instance, the profile's `FileTemplate` field is ignored. Here's an example of piping the results of `ps` to a file with an auto-generated name: ```sh @@ -150,17 +150,19 @@ brew uninstall template brew untap fuzzy-rp/template ``` -## Package and installation +## Installation with source This repo is available as a go package [`gitlab.com/fuzzy-rp/template`](https://pkg.go.dev/gitlab.com/fuzzy-rp/template). To install, clone the repo and run this command from the repo directory: -`go install gitlab.com/fuzzy-rp/template@latest` +`make install` + +### Uninstall with source To uninstall, run this command from the repo directory: -`go clean -i gitlab.com/fuzzy-rp/template...` +`make uninstall` -### Running after installation +## Running after installation - `template` - uses default profile "note" to create a date-stamped MD file in current folder - `template blog` OR `template --profile blog` OR `template -p blog` - creates a date-stamped MD file in ~/Blog, opens in VSCode @@ -171,7 +173,7 @@ To uninstall, run this command from the repo directory: - *Note*: this will overwrite whatever config changes you may have made - *Note*: the defaults may change from version to version -### Creating symbolic links +## Creating symbolic links template currently refers to paths under `~`. This is to ensure that it works on all systems. @@ -197,7 +199,12 @@ 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. +The following command will build the package, test it, and then install it: +```sh +make install +``` + +I use this approach, but that's because I use `template xyz` multiple times a day, and find it helpful to test out a work in progress, and to be using the latest version. ## Support @@ -235,7 +242,8 @@ I want to keep this CLI simple. To that extent, I'm not interested in adding too Good guidance is invaluable, IMO, so to this extent I am very bullish about adding and using descriptive Makefile and VS Code launch tasks. Makefile should be used for any build/test/release task. If there is a reason to run a task more than once *in the lifetime of a project*, add the task to the Makefile with a descriptive name. -I don't want to see complicated steps embedded in READMEs or (worse) in code. If the task is important, one that a maintainer/developer/user *may* want to do, add it to Makefile. +I don't want to see complicated steps embedded in READMEs or (worse) in code. +If the task is important, one that a maintainer/developer/user *may* want to do multiple times, add it to Makefile. Similarly, if there is a good VSCode debug scenario, add a task to launch.json. @@ -243,9 +251,8 @@ Similarly, if there is a good VSCode debug scenario, add a task to launch.json. Here is the future feature list: -1. Publish Homebrew version of app, possibly using [this GoReleaser Homebrew documentation](https://goreleaser.com/customization/homebrew/) -2. Publish Chocolatey version of app, possibly using [this GoReleaser Chocolatey documentation](https://goreleaser.com/customization/chocolatey/) -3. Support for passing in a list of template values for custom values in the template. Use might look like this: `template work form123 --id=456 --corpOffice=SEA`. The passed-in extra values will be placed somewhere inside the template. Some value keys will not be allowed, like "time". +1. Publish Chocolatey version of app, possibly using [this GoReleaser Chocolatey documentation](https://goreleaser.com/customization/chocolatey/) +2. Support for passing in a list of template values for custom values in the template. Use might look like this: `template work form123 --id=456 --corpOffice=SEA`. The passed-in extra values will be placed somewhere inside the template. Some value keys will not be allowed, like "time". ## Contributing