Getting Started

Installation

.env

The .env file helps to set up any personal preferences. If anything could be configured, this is the first place to look.

There's a .env.dist file to give a quick overview as to what might be configurable.

Task

In this repository, we use Task. It's a more descriptive tool than Make to structure commands and dependencies.

Notice that tasks are not magic; anything that can be done with Task, should be able to be done manually as well.

But Taskfiles help to make sure that dependencies and flags are being checked and provided, and that some tasks are done before others.

Manage Task with their official documentation

There's official documentation on how to install Task on their website.

Manage Task with Make

There's also a Makefile in this repository, that should work on any POSIX compliant system.

To install task to the env(BIN_DIR) directory, and alias it in your env(ALIAS_FILE) file:

make
# or
make install

To load the alias in, either open a new terminal, or source the env(ALIAS_FILE).

To clean up any file created by the Makefile:

make clean

Usage