|
@@ -3,33 +3,27 @@ A meta micro manager for the masses.
|
|
|
|
|
|
|
|
|
## What. Does. _That_. MEAN?
|
|
|
-The `gimme` command runs micro scripts that get small blocks of work done. These usually build on other tools and can be chained together. Ideally, it can do anything ~~that can be automated in shell~~.
|
|
|
+The `gimme` command runs micro scripts that get small blocks of work done. These usually build on other tools and can be chained together. Ideally, it can do anything [that can be automated in shell].
|
|
|
|
|
|
-It's like glue between tiny little tasks.
|
|
|
+It's like glue between tiny little tasks [like most shell scripts].
|
|
|
|
|
|
|
|
|
## No really... what does it do?
|
|
|
It deals with the shell scripts so that the engineers don't have to.
|
|
|
|
|
|
-yeah...
|
|
|
+yeah... right...
|
|
|
|
|
|
|
|
|
## Installation
|
|
|
```bash
|
|
|
curl -fsSL "https://github.com/KylePDavis/gimme/raw/master/gimme" | bash -
|
|
|
```
|
|
|
-_(you do read these scripts, right?)_
|
|
|
+_(you do read these shell scripts before just running them, right!?)_
|
|
|
|
|
|
|
|
|
## Usage
|
|
|
```bash
|
|
|
-gimme goodies
|
|
|
-
|
|
|
-# if it exists, run:
|
|
|
-"$GIMME_DIR/gimmes/goodies"
|
|
|
-
|
|
|
-# otherwise, run the nearest _default (as an example, this wraps your package manager):
|
|
|
-"$GIMME_DIR/gimmes/_default"
|
|
|
+gimme THAT_THING_THAT_YOU_WANT
|
|
|
```
|
|
|
|
|
|
|
|
@@ -40,11 +34,21 @@ source "$GIMME_DIR/gimme"
|
|
|
```
|
|
|
|
|
|
|
|
|
+## Internals
|
|
|
+```bash
|
|
|
+# 1. try to run :
|
|
|
+"$GIMME_DIR/gimmes/$THAT_THING_THAT_YOU_WANT"
|
|
|
+
|
|
|
+# 2. if not, then run the nearest _default script, which should go and get things
|
|
|
+"$GIMME_DIR/gimmes/_default"
|
|
|
+```
|
|
|
+
|
|
|
+
|
|
|
## Customization
|
|
|
1. write a shell script that does something awesome
|
|
|
- * you can depend on other "gimmes" by simply calling `gimme that other thing` at the top
|
|
|
- * add a check to make sure that it does nothing on subsequent runs -- idempotence is sexy
|
|
|
- * helpers like `has` and `gimme_pkg` get inherited from the main `gimme` script if you want
|
|
|
+ * you can depend on other "gimmes" by simply calling `gimme that other thing` at the top
|
|
|
+ * add a check to make sure that it does nothing on subsequent runs -- idempotence is sexy
|
|
|
+ * helpers like `has` and `gimme_pkg` get inherited from the main `gimme` script if you want
|
|
|
2. put it into the `$GIMME_DIR/gimmes/` directory
|
|
|
3. make it executable with something like `chmod 755 YOUR_GIMME_SCRIPT`
|
|
|
|