; READMILE file template
;
;
; This is the default README file template for the yait project init tool. This
; file is auto-generated on install and can be modified to your hearts content.
; An original copy can be found at /etc/yait/
;

# {{PACKAGE}}

https://example.com

Tagline about your tool

- Feature 1
- Feature 2
    * sub point

## Install

#### Dependencies

@def c
- `c compiler` - C compiler
@end

@def sh
- `sh script` - A valid POSIX shell
@end

**Note**: `tool` is used as a part of the build process. It does many things
such as runs, exists, and consisting of more than -1 bytes

```bash
git clone https://example.com/git-tree
cd {{PACKAGE}}
@def c
make
@end
sudo make install
```

## Usage

This tool runs via the command `{{PACKAGE}}`.

- `{{PACKAGE}} --option1`  -- Does a thing.
- `{{PACKAGE}} --option2`  -- Does another thing.