michael/swift-hpa
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 5 Wiki Activity

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

Browse Source
This commit is contained in:
Michael Housh
2024-12-18 14:47:32 -05:00
committed by Michael Housh
parent 1820988894
commit d3a9aa2f00
1 changed files with 6 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
README.md
View File

@@ -18,13 +18,10 @@ brew tap michael/formula https://git.housh.dev/michael/homebrew-formula
brew install michael/formula/hpa brew install michael/formula/hpa
``` ```
<<<<<<< HEAD
Installation on platforms other than `macOS` are currently being worked on, along with support for Installation on platforms other than `macOS` are currently being worked on, along with support for
running in a `docker` container. running in a `docker` container.
======= ### Ensuring dependencies are installed
>>>>>>> 2944a12 (feat: Adds readme and license files)
### Ensuring dependencies are installed.
This application requires some dependencies to be installed on your system, you can install the This application requires some dependencies to be installed on your system, you can install the
dependencies with the following command. 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 repositories, and encrypt / decrypt variable files. The playbook get's installed to
`~/.local/share/hpa/playbook`. `~/.local/share/hpa/playbook`.
<<<<<<< HEAD
> NOTE: All commands accept a `--help` option which will display the arguments and options a command > 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. > can use, along with example usage of the commands.
======= ### Configure the application
>>>>>>> 2944a12 (feat: Adds readme and license files)
### Configure the application.
When you first download the application you can setup the configuration file for your use case. 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 Once your template is setup, make sure that your configuration file is setup to point to your
customized template. 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 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. 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. Or if your configuration has `directory` set in the `template` section.
```bash ```bash
<<<<<<< HEAD
hpa create --use-local-template ~/consults/my-first-consult 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 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. 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. LaTeX
1. HTML 1. HTML
## Build command. ## Build command
The command line tool goes through an intermediate step when generating output, which is called 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 `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 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 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 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 `-v | --verbose` that will increase the logging output. This can be passed multiple times, so for
the highest log output you can do `-vvv`. the highest log output you can do `-vvv`.
=======
>>>>>>> 2944a12 (feat: Adds readme and license files)
## Uninstalling ## Uninstalling
You can uninstall the application using: You can uninstall the application using: