Permalink
Browse files

updated README

  • Loading branch information...
1 parent 6f85d89 commit ff7d19963e06641253522f2cc257c1aaa321343a @bakkdoor bakkdoor committed Apr 27, 2012
Showing with 32 additions and 1 deletion.
  1. +32 −1 README.md
View
33 README.md
@@ -5,9 +5,40 @@ Fake is a new work-in-progress build and automation tool for Fancy, similar to R
## Tasks
Fake allows the definition of tasks that may depend on other tasks to complete.
-Given a task names `clean` you can invoke it like so:
+
+Given a `Fakefile` with the following contents:
+
+```fancy
+Fake tasks: {
+ clean: {
+ desc: "Remove all *.fyc files"
+ run: {
+ sh: ("rm", "-rf", Directory list: "**/*.fyc") verbose: true
+ }
+ }
+}
+```
+
+You can invoke it like so:
```
$ fake clean
```
+To list all available tasks run:
+
+```
+$ fake -T
+fake clean | Remove all *.fyc files
+```
+
+To see a list of general options use the help command:
+
+```
+$ fake --help
+```
+
+## Note:
+
+This is still in the making. More features coming soon, but defining
+basic tasks and dependencies between them works fine already.

0 comments on commit ff7d199

Please sign in to comment.