diff --git a/README.md b/README.md index 6a68355..a1e874a 100644 --- a/README.md +++ b/README.md @@ -1,33 +1,11 @@ -### Automate Workflows—Bootstrap Development Environments—Commit The Tasks (*i.e.* `git`) - - -![vanity image](https://github.com/kennethreitz/bake/blob/master/ext/img.jpg?raw=true) - - - -
-    $ bake, n:
-    the s☿rangely familiar task runner.
-
-
- --------------------- - - -I love using `Makefile` for one-off **tasks** in projects. - -The problem with doing this is that you can't use familiar bash–isms when doing so, as **GNU Make** doesn't use the familiar **Bash** syntax, nor does it allow for simple ad–hoc use of arbitrary scripting languages (e.g. **Python**). - -This project seeks to bridge all of these worlds into a single entrypoint — ideal for cross–language repositories. - ----------------- -

 

-

What's in the oven?

+
+ +

$ bake — the strangely familiar task–runner.            

-
-    
+ +
$ cat Bakefile $ bake install install: install/node install/python + Executing install/node: echo 'All ready!' | yarn install v1.17.3 @@ -50,20 +28,35 @@ This project seeks to bridge all of these worlds into a single entrypoint — i
+## What's in the oven? + + -- A `Bakefile`, which looks and feels like the good parts of a `Makefile`. -- Except, you can write real bash code! -- Environment variables are explicitly passed or whitelisted (allowed), not inherited from the parent shell. -- Unlike `Makefile`, either tabs or 4 spaces can be used. -- Tasks can be run safely and reliably. Rest assured that scripts are executed from the project root (e.g. location of the `Bakefile`). -- See [advanced example](https://github.com/kennethreitz/bake#advanced-usage-sample) for further, juicy, details. ------------------ -## Installing `$ bake` +### Automate Workflows — Bootstrap Development Environments — Commit The Tasks -### **Various `*`nix Distributions** (Python 3.6+): +I love using `Makefile` for one-off **tasks** in projects. + +The problem with doing this is that you can't use familiar bash–isms when doing so, as **GNU Make** doesn't use the familiar **Bash** syntax, nor does it allow for simple ad–hoc use of arbitrary scripting languages (e.g. **Python**). + +This project seeks to bridge all of these worlds into a single entrypoint — ideal for cross–language repositories + +------------------- + +## Bootstraping `bake`, locally + + +#### **Various `*`nix Distributions** (Python 3.6+): The primary installation method of `bake`, today, is via `pip`: @@ -76,7 +69,7 @@ Successfully installed bake-cli-0.2.0 delegator.py-0.1.1 pexpect-4.7.0 ptyproces This will always work, but it will not be the default recommendation. -## MacOS (Previously known as OS X) +#### MacOS (Previously known as OS X) Installation of `bake` will (soon) be very easy, with Homebrew. The formula needs a subtle adjustment — if you want to help, [here's the repo](http://github.com/kennethreitz/homebrew--)! @@ -91,7 +84,7 @@ Homebrew will be the primary installation target of `bake`. ✨🍰✨ -## Containers! *e.g.* Docker. +#### Containers! *e.g.* Docker. You an also run `bake` via Docker! An official image has been made available: @@ -186,8 +179,7 @@ This software has been designed for you, with much joy, by - As above, so below. +