diff options
Diffstat (limited to 'README.markdown')
| -rw-r--r-- | README.markdown | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown new file mode 100644 index 0000000..33fddcb --- /dev/null +++ b/README.markdown @@ -0,0 +1,30 @@ +vcsrepo +======= + +Purpose +------- + +This provides a single type, `vcsrepo`. + +This type can be used to describe: + +* A working copy checked out from a (remote or local) source, at an + arbitrary revision +* A "blank" working copy not associated with a source (when it makes + sense for the VCS being used) +* A "blank" central repository (when the distinction makes sense for the VCS + being used) + +Supported Version Control Systems +--------------------------------- + +This module supports a wide range of VCS types, each represented by a +separate provider. + +For information on how to use this module with a specific VCS, see +`README.<VCS>.markdown`. + +License +------- + +See LICENSE. |