README & License #3

Merged
michael merged 3 commits from dev into main 2024-12-19 14:41:37 +00:00
2 changed files with 18 additions and 2 deletions
Showing only changes of commit d1de0e1996 - Show all commits

View File

@@ -18,6 +18,9 @@ brew tap michael/formula https://git.housh.dev/michael/homebrew-formula
brew install michael/formula/hpa
```
Installation on platforms other than `macOS` are currently being worked on, along with support for
running in a `docker` container.
### Ensuring dependencies are installed.
This application requires some dependencies to be installed on your system, you can install the
@@ -93,7 +96,7 @@ hpa create --template-dir ~/projects/my-template ~/consults/my-first-consult
Or if your configuration has `directory` set in the `template` section.
```bash
hpa create -l ~/consults/my-first-consult
hpa create --use-local-template ~/consults/my-first-consult
```
## Generating output files.
@@ -144,6 +147,16 @@ like to generate output for.
hpa build --project-directory ~/consults/my-first-consult
```
## Some General Usage Notes:
There is often a lot of output to the console when running commands, which can be problematic if you
want to pipe the output into other command line tools, so all options accept a `-q | --quiet` flag
which will suppress logging output and allow piping into other commands.
Along the similar line, if you would like to increase the logging output then all commands accept
`-v | --verbose` that will increase the logging output. This can be passed multiple times, so for
the highest log output you can do `-vvv`.
## Uninstalling
You can uninstall the application using:

View File

@@ -40,7 +40,10 @@ struct CreateCommand: AsyncParsableCommand {
var templateDir: String?
@Flag(
name: .shortAndLong,
name: [
.short,
.customLong("use-local-template")
],
help: "Force using a local template directory."
)
var localTemplateDir = false