Browse Source

new: doc: added quick ``README.rst`` to detail purpose and related packages.

postgres
Valentin Lab 9 years ago
parent
commit
33f162bc45
  1. 26
      README.rst

26
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
Loading…
Cancel
Save