summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorLars Wirzenius <lars.wirzenius@codethink.co.uk>2011-11-02 16:04:40 +0000
committerLars Wirzenius <lars.wirzenius@codethink.co.uk>2011-11-02 16:04:40 +0000
commit15e2c96e24f56228c57be4af2d6a601a93695506 (patch)
tree33e48ecb018f72b41011dea3e02828c12bfa4193 /README
parented33c0b35d5959bcd0b4d9f75bc6fba1f9df0b76 (diff)
downloadmorph-15e2c96e24f56228c57be4af2d6a601a93695506.tar.gz
Document new command line usage
Diffstat (limited to 'README')
-rw-r--r--README15
1 files changed, 12 insertions, 3 deletions
diff --git a/README b/README
index 16a44559..fd34a3b7 100644
--- a/README
+++ b/README
@@ -73,12 +73,21 @@ To build a stratum:
}
To use morph, create the relevant morphology files (`*.morph`),
-then run a command like the following:
+commit them to a git repository, and then run a command like the following:
- morph build core.morph
+ morph build file://$HOME/baserock/morphs master core.morph
This will build the Baserock core stratum. It will recursively build
-any chunks that also need to be built.
+any chunks that also need to be built. The last three command line
+arguments are:
+
+* URL to repository; this may be relative to `--git-base-url` or absolute.
+* A git commit reference; here, the HEAD of the `master` branch is used.
+* The filename in the git commit.
+
+Note that morph retrieves the morphology file from git. It does not use
+the copy that is checked out. If you make any modifications, you **must**
+commit them.
Morphology spec