feat: More readme, also removes ci from dev branch and only runs for pulls and pushes to main.

This commit is contained in:
2024-12-18 14:47:32 -05:00
committed by Michael Housh
parent 1820988894
commit d3a9aa2f00

View File

@@ -18,13 +18,10 @@ brew tap michael/formula https://git.housh.dev/michael/homebrew-formula
brew install michael/formula/hpa
```
<<<<<<< HEAD
Installation on platforms other than `macOS` are currently being worked on, along with support for
running in a `docker` container.
=======
>>>>>>> 2944a12 (feat: Adds readme and license files)
### Ensuring dependencies are installed.
### Ensuring dependencies are installed
This application requires some dependencies to be installed on your system, you can install the
dependencies with the following command.
@@ -44,13 +41,10 @@ It will also download an ansible-playbook that is used to generate output files,
repositories, and encrypt / decrypt variable files. The playbook get's installed to
`~/.local/share/hpa/playbook`.
<<<<<<< HEAD
> NOTE: All commands accept a `--help` option which will display the arguments and options a command
> can use, along with example usage of the commands.
=======
>>>>>>> 2944a12 (feat: Adds readme and license files)
### Configure the application.
### Configure the application
When you first download the application you can setup the configuration file for your use case.
@@ -82,7 +76,7 @@ allows your template to expand over time.
Once your template is setup, make sure that your configuration file is setup to point to your
customized template.
## Creating a project.
## Creating a project
The first step after having your template defined is to create a project that uses it. The below
command will create a template in the `~/consults/my-first-consult` directory.
@@ -102,14 +96,10 @@ hpa create --template-dir ~/projects/my-template ~/consults/my-first-consult
Or if your configuration has `directory` set in the `template` section.
```bash
<<<<<<< HEAD
hpa create --use-local-template ~/consults/my-first-consult
=======
hpa create -l ~/consults/my-first-consult
>>>>>>> 2944a12 (feat: Adds readme and license files)
```
## Generating output files.
## Generating output files
Once you have created a project and edited the contents to your liking. You can then generate the
final output file (typically a pdf) that can be sent to your customer.
@@ -132,7 +122,7 @@ Currently the supported output file types are:
1. LaTeX
1. HTML
## Build command.
## Build command
The command line tool goes through an intermediate step when generating output, which is called
`build`. The build step generates the final output files using defined variables that are located in
@@ -157,8 +147,7 @@ like to generate output for.
hpa build --project-directory ~/consults/my-first-consult
```
<<<<<<< HEAD
## Some General Usage Notes:
## 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
@@ -168,8 +157,6 @@ Along the similar line, if you would like to increase the logging output then al
`-v | --verbose` that will increase the logging output. This can be passed multiple times, so for
the highest log output you can do `-vvv`.
=======
>>>>>>> 2944a12 (feat: Adds readme and license files)
## Uninstalling
You can uninstall the application using: