template / commit
Slight rewording of the Readme.
README.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 1aa66bd..6036360 100644 --- a/README.md +++ b/README.md @@ -58,6 +58,8 @@ This will cause VSCode to open the `~\Dropbox\DailyNotes` folder as a workspace, 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 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 @@ -110,11 +112,7 @@ Here are the basic features of the CLI that I want to keep: "Keep It Simple, Stupid" -I want to keep this CLI simple. To that extent, I'm not interested in adding features that can be performed by other processes. - -For example: the configuration YAML file is expected to be at `~/.templates.yaml`. We can add code to look up the config from a different location, for example from `~/configs/.templates.yaml` by setting an env var. But I'd rather keep the config path the same and ask that the user create a symlink instead. - -Same for templating. I'm only interested in doing the bare essentials, such as generating file contents from a template, and having more complex logic be performed by external scripts. +I want to keep this CLI simple. To that extent, I'm not interested in adding too many features. My main requirement right now is: `template blog topic` should do the same thing as `template --profile blog --name topic`. The CLI should also not be too opinionated. Aside from `go`, there are no other requirements. Default profiles might need VSCode and/or pwsh, but the user can always override that.