docs: add reference to default shell requirements

This commit is contained in:
Daylin Morgan 2022-09-21 16:31:54 -05:00
parent c85f5f8103
commit e608a90b5a
3 changed files with 6 additions and 10 deletions

View file

@ -24,7 +24,7 @@ Current Features:
- custom print function
- confirmation prompt
Depends on `GNU Make`, obviously and `Python >=3.7`.
Depends on `GNU Make`, obviously and `Python >=3.7`, and `bash` (or `zsh`).
Wait python?!?!, I'm not `pip` installing some package just to parse my makefile.
I agree, all you need is one file [`.task.mk`](./task.mk).

View file

@ -20,7 +20,7 @@ Current Features:
- custom print function
- confirmation prompt
Depends on `GNU Make`, obviously and `Python >=3.7`.
Depends on `GNU Make`, obviously and `Python >=3.7`, and `bash` (or `zsh`).
Wait python?!?!, I'm not `pip` installing some package just to parse my makefile.
I agree, all you need is one file [`.task.mk`](https://github.com/daylinmorgan/task.mk/v22.9.19/task.mk).

View file

@ -56,23 +56,19 @@ See this project's `make info` for an example.
You can quickly customize some of the default behavior of `task.mk` by overriding the below variables prior to the `-include .task.mk`.
```make
# ---- CONFIG ---- #
# ---- [config] ---- #
HEADER_STYLE ?= b_cyan
PARAMS_STYLE ?= b_magenta
ACCENT_STYLE ?= b_yellow
PARAMS_STYLE ?= $(ACCENT_STYLE)
GOAL_STYLE ?= $(ACCENT_STYLE)
MSG_STYLE ?= faint
DIVIDER_STYLE ?= default
DIVIDER ?= ─
HELP_SEP ?= │
# python f-string literals
EPILOG ?=
define USAGE ?=
{ansi.$(HEADER_STYLE)}usage{ansi.end}:
make <recipe>
endef
USAGE ?={ansi.$(HEADER_STYLE)}usage{ansi.end}:\n make <recipe>\n
INHERIT_SHELL ?=
```
To use a custom color for one of the predefined configuration variables specify only the custom method.