summaryrefslogtreecommitdiff
path: root/doc/usage.mdwn
diff options
context:
space:
mode:
authorJoey Hess2016-11-11 20:44:31 -0400
committerJoey Hess2016-11-11 20:44:31 -0400
commit383c1a1ac1c5ab83945b073ecb7b6089cf79fba3 (patch)
treefbeaf7a6952dca1bea0607aebc2a4fbc40231672 /doc/usage.mdwn
parentbafa1691900970efcf2a772f094db1db874dacaf (diff)
document --init
Diffstat (limited to 'doc/usage.mdwn')
-rw-r--r--doc/usage.mdwn10
1 files changed, 6 insertions, 4 deletions
diff --git a/doc/usage.mdwn b/doc/usage.mdwn
index 16e559fa..02686d5f 100644
--- a/doc/usage.mdwn
+++ b/doc/usage.mdwn
@@ -13,11 +13,13 @@ and configured in haskell.
# MODES OF OPERATION
-* propellor
+* propellor --init
+
+ Get started by initializing a `~/.propellor/` repository.
- The first time you run `propellor`, without any options,
- it will set up a `~/.propellor/` repository. Edit `~/.propellor/config.hs`
- to configure it.
+ After this, you'll edit `~/.propellor/config.hs` to configure propellor.
+
+* propellor
Once propellor is configured, running it without any options will take
action as needed to satisfy the configured properties of the local host.