diff options
| author | Lauren Rother <lauren.rother@puppetlabs.com> | 2014-11-20 11:57:00 -0800 |
|---|---|---|
| committer | Lauren Rother <lauren.rother@puppetlabs.com> | 2014-11-20 11:57:00 -0800 |
| commit | ec7cb205f9b6c7aa82621e0c3143dc0ecb6457b6 (patch) | |
| tree | eba2df8d27418ebdcb13cb9cac80225d2246d81e /README.markdown | |
| parent | 4a9c69cb9d1242cdb53d1e758c07bdf79a8556cb (diff) | |
Updates README per MODULES-1425
Adds note to Setup section stating that the module will not create parent directories or install VCS software.
Diffstat (limited to 'README.markdown')
| -rw-r--r-- | README.markdown | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown index 08b8865..cefa50b 100644 --- a/README.markdown +++ b/README.markdown @@ -41,6 +41,10 @@ This module provides a single type with providers for each VCS, which can be use ##Setup +Before you begin using vcsrepo, it's worth keeping in mind that this module will not install VCS software for you. If you are going to use this module, you must have already installed your preferred VCS. + +Also, this module, like Puppet generally, will not create parent directories for you. You will need to have your parent directories in place before you begin. + ###Beginning with vcsrepo To get started with the vcsrepo module, you must simply define the type `vcsrepo` with a path to your repository and the [type of VCS](#Usage) you're using in `provider` (in the below example, Git). |