[libdist-zilla-role-bootstrap-perl] 07/19: Update README

[Axel Beckert]

This is an automated email from the git hooks/post-receive script.

abe pushed a commit to annotated tag 0.2.1-source
in repository libdist-zilla-role-bootstrap-perl.

commit 3541e8d0d5ed20aed81d7d1ecd7646845f81c07b
Author: Kent Fredric <kentfredric at gmail.com>
Date:   Tue Sep 10 15:54:25 2013 +1200

    Update README
---
 README      |  0
 README.mkdn | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 53 insertions(+)

diff --git a/README b/README
deleted file mode 100644
index e69de29..0000000
diff --git a/README.mkdn b/README.mkdn
new file mode 100644
index 0000000..a1a378e
--- /dev/null
+++ b/README.mkdn
@@ -0,0 +1,53 @@
+# ABOUT
+
+This repository contains a directory full of utilities to bolt on
+to CPAN-targeting distributions, to add useful `travis-ci` features to those dists.
+
+# PREREQS
+
+All that is needed at present to get started, is a copy of `git` that provides `git subtree`, and a copy of `Path::FindDev` from `CPAN`.
+
+You don't need `Path::FindDev` during deployment, its just used to streamline
+automated patching.
+
+# INSTALLING
+
+First, check out a copy of these scripts, it can be a temporary directory,
+and you'll only need to do this once.
+
+```shell
+  > mkdir /tmp/tci-scripts
+  > cd    /tmp/tci-scripts
+  > git   clone https://github.com/kentfredric/travis-scripts.git
+```
+
+Then, chdir to the root of your project
+
+```shell
+  > chdir $PROJECT
+```
+
+And lastly, execute the installer
+
+```shell
+  > /tmp/tci-scripts/sync_tree.pl
+```
+
+This will create the folder called `maint` within your distribution,
+with a tree installed by `git subtree`, which will track this distribution.
+
+To update your copy of `/maint` to the latest, simply execute
+
+```shell
+  > $PROJECT/maint/sync_tree.pl
+```
+
+While somewhere in your project.
+
+# CAVEATS
+
+Note, this tool uses `Path::FindDev`, and by proxy, `Path::IsDev` to find a development
+root directory somewhere in the ancestry of `$CWD`.
+
+As such, you will likely need to appease `Path::IsDev` by having a file of some description that
+marks the root of the development tree.

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-perl/packages/libdist-zilla-role-bootstrap-perl.git