From 33f162bc45346f5200e7c44e8831165643c88425 Mon Sep 17 00:00:00 2001 From: Valentin Lab Date: Wed, 21 Jan 2015 14:49:02 +0700 Subject: [PATCH] new: doc: added quick ``README.rst`` to detail purpose and related packages. --- README.rst | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 README.rst diff --git a/README.rst b/README.rst new file mode 100644 index 00000000..cbb624d0 --- /dev/null +++ b/README.rst @@ -0,0 +1,26 @@ +0k-charms +========= + +This package provides charms for the ``lxc-deploy`` and +``docker-build-charm`` commands respectively from ``lxc-scripts`` and +``0k-docker`` packages. + +A charm is basically a set of metadata and a shell script that will be +executed to create an image for lxc or docker. + + +Installation +============ + +Be sure to install ``lxc-scripts`` and ``0k-docker`` packages and that +their binaries are accessible to user 'root'. + +By default, ``lxc-deploy`` and ``docker-build-charm`` will look for the +charm store to be located in ``/srv/charm-store``. This can be a symbolic +link. + +For instance, if ``0k-charms`` is installed in ``/opt/apps/0k-charms``, +you would do:: + + ln -sf /opt/apps/0k-charms/precise /srv/charm-store +