summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--doc/README.mdwn12
1 files changed, 6 insertions, 6 deletions
diff --git a/doc/README.mdwn b/doc/README.mdwn
index 50348c3a..c509ccdc 100644
--- a/doc/README.mdwn
+++ b/doc/README.mdwn
@@ -35,25 +35,25 @@ see [configuration for the Haskell newbie](https://propellor.branchable.com/hask
## quick start
-1. Get propellor installed on your laptop.
+1. Get propellor installed on your development machine (ie, laptop).
`cabal install propellor`
or
`apt-get install propellor`
-2. Run propellor for the first time. It will set up a `~/.propellor/` git
+2. Run `propellor` for the first time. It will set up a `~/.propellor/` git
repository for you.
3. If you don't have a gpg private key already, generate one: `gpg --gen-key`
4. Run: `propellor --add-key $KEYID`, which will make propellor trust
your gpg key, and will sign your `~/.propellor` repository using it.
5. Edit `~/.propellor/config.hs`, and add a host you want to manage.
You can start by not adding any properties, or only a few.
-6. Pick a host and run: `propellor --spin $HOST`
+6. Run: `propellor --spin $HOST`
7. Now you have a simple propellor deployment, but it doesn't do
much to the host yet, besides installing propellor.
- So, edit `~/.propellor/config.hs` to configure the host (maybe
- start with a few simple properties), and re-run step 6.
+ So, edit `~/.propellor/config.hs` to configure the host, add some
+ properties to it, and re-run step 6.
Repeat until happy and move on to the next host. :)
8. Optionally, set up a [centralized git repository](https://propellor.branchable.com/centralized_git_repository/)
- so multiple hosts can be updated with a simple `git commit -S; git push`
+ so that multiple hosts can be updated with a simple `git commit -S; git push`
9. Write some neat new properties and send patches!
## debugging