From 4e2a771b8cbca9c76a7d3e67ce95d0b49bcf786b Mon Sep 17 00:00:00 2001
From: daylin <47667941+daylinmorgan@users.noreply.github.com>
Date: Mon, 5 Sep 2022 20:20:10 -0500
Subject: [PATCH] docs: typos
---
Makefile | 2 +-
README.md | 10 +++---
assets/help.svg | 90 ++++++++++++++++++++++++-------------------------
3 files changed, 51 insertions(+), 51 deletions(-)
diff --git a/Makefile b/Makefile
index 62fae9c..ba89e4a 100644
--- a/Makefile
+++ b/Makefile
@@ -77,7 +77,7 @@ as python {a.bold}f-string{a.end} literals
{a.end}
endef
-## info | demonsrtate usage of tprint
+## info | demonstrate usage of tprint
.PHONY: task
info:
$(call header, Info Message)
diff --git a/README.md b/README.md
index 8683394..bd0a3f9 100644
--- a/README.md
+++ b/README.md
@@ -119,8 +119,8 @@ You can take advantage of the builtin python script runner and write multi-line
This is a simple example but a few lines of python in your `Makefile`
may be easier than balancing sub-shells and strung together awk commands.
-When `make` expands the function it will take the parameters passed to `py` and expand them `$(1)` is the variable name.
-`$(2)` in this case is the implicit pattern from the rule. Pay attention to quotes.
+When `make` expands the function it will take the parameters passed to `py` and expand them.
+`$(1)` is the variable name and `$(2)` in this case is the implicit pattern from the rule. Pay attention to quotes.
If you need to debug your python script, use `DEBUG=1` when you run `make` and it will first print the script that will be piped to `python`.
```make
@@ -135,7 +135,7 @@ list-%:
$(call py,list_files_py,$*)
```
-For what it's worth there is also a predefined function for `bash` (named `tbash`) as well should you need to accomplish something similar of more easily embedding your bash script rather than having to escape every line with '\'.
+For what it's worth there is also a predefined function for `bash` (named `tbash`) as well should you need to accomplish something similar of more easily embedding your bash script rather than having to escape every line with a backslash.
```make
define bash_script
@@ -182,10 +182,10 @@ But I just want a basic help output, surely I don't need python for this... you
```make
## h, help | show this help
.PHONY: help h
-help h: Makefile params
+help h: Makefile
@awk -v fill=$(shell sed -n 's/^## \(.*\) | .*/\1/p' $< | wc -L)\
'match($$0,/^## (.*) \|/,name) && match($$0,/\| (.*)$$/,help)\
{printf "\033[1;93m%*s\033[0m | \033[30m%s\033[0m\n",\
fill,name[1],help[1];} match($$0,/^### (.*)/,str) \
{printf "%*s \033[30m%s\033[0m\n",fill," ",str[1];}' $<
-```
\ No newline at end of file
+```
diff --git a/assets/help.svg b/assets/help.svg
index 596e1d8..1b038ff 100644
--- a/assets/help.svg
+++ b/assets/help.svg
@@ -16,14 +16,14 @@
font-weight: 700;
}
- .terminal-649569392-matrix {
+ .terminal-649700464-matrix {
font-family: Fira Code, monospace;
font-size: 20px;
line-height: 24.4px;
font-variant-east-asian: full-width;
}
- .terminal-649569392-title {
+ .terminal-649700464-title {
font-size: 18px;
font-weight: bold;
font-family: arial;
@@ -33,95 +33,95 @@
-webkit-filter: drop-shadow( 2px 5px 2px rgba(0, 0, 0, .7));
filter: drop-shadow( 2px 5px 2px rgba(0, 0, 0, .7));
}
- .terminal-649569392-r1 { fill: #94e2d5;font-weight: bold }
-.terminal-649569392-r2 { fill: #c6d0f5 }
-.terminal-649569392-r3 { fill: #f5c2e7;font-weight: bold }
-.terminal-649569392-r4 { fill: #c6d0f5;font-style: italic;;text-decoration: underline; }
-.terminal-649569392-r5 { fill: #f9e2af;font-weight: bold }
-.terminal-649569392-r6 { fill: #8288a5 }
+ .terminal-649700464-r1 { fill: #94e2d5;font-weight: bold }
+.terminal-649700464-r2 { fill: #c6d0f5 }
+.terminal-649700464-r3 { fill: #f5c2e7;font-weight: bold }
+.terminal-649700464-r4 { fill: #c6d0f5;font-style: italic;;text-decoration: underline; }
+.terminal-649700464-r5 { fill: #f9e2af;font-weight: bold }
+.terminal-649700464-r6 { fill: #8288a5 }
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
-
+
- make help
+ make help
-
+
-
- usage:
-make <recipe>
-
- Turn your `Makefile` into
- the task runner you always needed.
- See the example output below.
-
-bootstrap | generate local dev environment
- lint | lint the python
- assets | generate assets
- list-% | use pathlib.Path to list files
- release | release new version of task.mk
- c, clean | remove the generated files
- info | demonsrtate usage of tprint
- h, help | show this help
-
-for more info: see github.com/daylinmorgan/task.mk
+
+ usage:
+make <recipe>
+
+ Turn your `Makefile` into
+ the task runner you always needed.
+ See the example output below.
+
+bootstrap | generate local dev environment
+ lint | lint the python
+ assets | generate assets
+ list-% | use pathlib.Path to list files
+ release | release new version of task.mk
+ c, clean | remove the generated files
+ info | demonstrate usage of tprint
+ h, help | show this help
+
+for more info: see github.com/daylinmorgan/task.mk