diff --git a/README.md b/README.md index 55060ae..c82db0b 100644 --- a/README.md +++ b/README.md @@ -24,6 +24,12 @@ Options: -h, --help Show this message and exit. ``` +### Features & Such + +- a `Bakefile`, which looks and feels like the good parts of a `Makefile`. +- except, you can write real bash code! +- Unlike `Makefile`, either tabs or 4 spaces can be used. + ![bake icon](https://github.com/kennethreitz/bake/blob/master/ext/bake.png?raw=true) @@ -54,10 +60,9 @@ system-deps: brew install pipenv ``` -**Running the above `Bakefile`**: +## `$ bake` ```console -$ bake - format - full-install - install @@ -67,14 +72,20 @@ $ bake - python-deps - node-deps - system-deps +``` -$ bake --silent format +## `$ bake --silent format` + +```console All done! โœจ ๐Ÿฐ โœจ 7 files left unchanged. +``` -$ bake install +## `$ bake install` + +```console ยท Executing 'node-deps': yarn install v1.17.3 [1/4] ๐Ÿ” Resolving packages... @@ -84,28 +95,28 @@ success Already up-to-date. Installing dependencies from Pipfile.lock (2ee04c)โ€ฆ ๐Ÿ โ–‰โ–‰โ–‰โ–‰โ–‰โ–‰โ–‰โ–‰โ–‰โ–‰โ–‰โ–‰โ–‰โ–‰โ–‰โ–‰โ–‰โ–‰โ–‰โ–‰โ–‰โ–‰โ–‰โ–‰โ–‰โ–‰โ–‰โ–‰โ–‰โ–‰โ–‰โ–‰ 8/8 โ€” 00:00:01 ยท Done. +``` -$ bake argv-example WHO=you 1 2 3 - ยท Executing 'argv-example': +## `$ bake argv-example WHO=you 1 2 3` + +```console +ยท Executing 'argv-example': ++ echo 'HELLO, you' HELLO, you ++ echo '[1,' 2, '3]' [1, 2, 3] ยท Done. +``` +## `$ bake dangerous-example` -$ bake dangerous-example +```console ยท Executing '@confirm:secure' ยท What is 10 times 2?: 7 ยท Aborted. ``` -## Features - -- a `Bakefile`, which looks and feels like the good parts of a `Makefile`. -- except, you can write real bash code! -- Unlike `Makefile`, either tabs or 4 spaces can be used. ## Installation