diff --git a/README.md b/README.md index 5e89572..c6ae583 100644 --- a/README.md +++ b/README.md @@ -5,9 +5,11 @@ Peru is a tool for including other people's code in your projects. It's a lot like [git submodules](http://git-scm.com/book/en/Git-Tools-Submodules), except that peru stays out of the way of your other tools. You write a `peru.yaml` -file and then run peru when you feel like it, like in your build scripts or in -your source control hooks. Your projects can live in git, hg, svn, tarballs, -whatever. And your dependencies can too. +file and then call `peru sync` when you need code, either by hand or in your +build scripts. Your projects can live in git, hg, svn, tarballs, whatever. And +your dependencies can too. + +![snazzy gif](https://raw.githubusercontent.com/buildinspace/peru/master/docs/peru.gif) ## Why? @@ -215,8 +217,9 @@ up to date, and you'll still be able to reach old versions in your history. There are also fields you can use in any module, which modify the the tree of files after it's fetched. These made an appearance in the fancy example above: - - `build`: A shell command to run on the fetched files. Fetching happens in a - temporary directory, and this command will be run there. + - `build`: A shell command to run on the fetched files. Fetching happens + somewhere in outer space (a temporary directory), and this command will be + run there. - `export`: A subdirectory that peru should treat as the root of the module tree. Everything else is dropped, including parent directories. Applies after `build`. diff --git a/docs/peru.gif b/docs/peru.gif new file mode 100644 index 0000000..3e92380 Binary files /dev/null and b/docs/peru.gif differ diff --git a/man/peru.1 b/man/peru.1 deleted file mode 100644 index ba8d430..0000000 --- a/man/peru.1 +++ /dev/null @@ -1,21 +0,0 @@ -.TH PERU 1 -.SH NAME -peru \- a modular build tool -.SH SYNOPSIS -.B peru -[\fB\-\-version\fR] -\fICOMMAND\fR [\fIARGS\fR...] -.SH DESCRIPTION -.B peru -builds multi-homed modules and dependencies -.SH OPTIONS -.TP -.BR \-\-version -Prints version information. -.SH COMMANDS -.TP -.BR pull " " [\fB\-\-flush-cache\fR] -Pulls source code and cached binaries to the local workspace. -.TP -.BR build " " [\fB\-\-flush-cache\fR] -Builds the local workspace.