template / commit
Updated readme with install and uninstall information and more examples.
README.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index a7bd8fb..58986d4 100644 --- a/README.md +++ b/README.md @@ -65,25 +65,26 @@ The build is managed by [make](https://www.gnu.org/software/make/). 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 +## Package and installation -- `make run` - uses default profile "note" to create a date-stamped MD file in current folder -- `make -e project=blog run` - creates a date-stamped MD file in ~/Dropbox/Blog, opens in VSCode -- `make -e profile=blog name=topic run` - creates a templated date-stamped MD file with `topic` in its name in ~/Blog, opens in VSCode +This repo is available as package [`gitlab.com/fuzzy-rp/template`](https://pkg.go.dev/gitlab.com/fuzzy-rp/template) and can be installed locally without cloning the repo. -## Installation +To install, run this command: +`go install gitlab.com/fuzzy-rp/template` -``` -make install -``` - -Note: the above installation will remove any local template/config changes you may have made. +To uninstall, run this command: +`go clean -i gitlab.com/fuzzy-rp/template` ### 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 - `template daily topic` OR `template --profile daily --name topic` OR `template -p daily -n topic` - creates a templated date-stamped MD file with `topic` in its name in ~/DailyNotes, opens in VSCode +- `template list` - lists all the found profiles +- `template get profile2` - lists detailed information about profile `profile2` +- `template reset` - resets the configuration to the default config + - *Note*: this will overwrite whatever config changes you may have made + - *Note*: the defaults may change from version to version ### Creating symbolic links @@ -107,9 +108,9 @@ ln -s ~/Dropbox/Therapy ~/Therapy ln -s ~/Dropbox/Work ~/Work ``` -### Dev loop +## Dev loop -TODO +[TODO] ## Support