diff --git a/doc/components.mdwn b/doc/components.mdwn index 93be79c..4c4d9c7 100644 --- a/doc/components.mdwn +++ b/doc/components.mdwn @@ -13,6 +13,8 @@ components. will put the command in `~/.cabal/bin/propellor`. This propellor command is just a wrapper; it builds and runs what you have set up in `~/.propellor/` +## full repository + Typically, the `~/.propellor/` git repository is set up by running the propellor command, or by [[cloning propellor|install]]. That makes the repository contain the full source code to propellor, including @@ -23,6 +25,8 @@ Don't like how a property works, or need to make it more general? Just edit then copy in `~/.propellor/src/Propellor/` and it will be used. See [[contributing]] if you want to send your improvements back. +## minimal config repository + All that really needs to be in `~/.propellor/` though, is a `config.hs` file, and a cabal file. To use propellor this way, you can first install propellor, and then copy the two files from the