Colin Watson has proposed merging ~cjwatson/lpcraft:readme into lpcraft:main.
Commit message: Add a simple README Requested reviews: Launchpad code reviewers (launchpad-reviewers) For more details, see: https://code.launchpad.net/~cjwatson/lpcraft/+git/lpcraft/+merge/411810 -- Your team Launchpad code reviewers is requested to review the proposed merge of ~cjwatson/lpcraft:readme into lpcraft:main.
diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..b28f79c --- /dev/null +++ b/README.rst @@ -0,0 +1,35 @@ +======= +lpcraft +======= + +``lpcraft`` is a runner for continuous integration jobs in Launchpad. It is +intended mainly for use in Launchpad builders, but can also be installed and +used locally on branches with a ``.launchpad.yaml`` file. + +This project owes a considerable amount to `snapcraft +<https://github.com/snapcore/snapcraft>`_ and `charmcraft +<https://github.com/canonical/charmcraft>`_: the provider support for +container management is based substantially on ``charmcraft``, while much of +the CLI design is based on both those tools. + +Running +======= + +``lpcraft`` is mainly intended to be consumed as a snap, and it currently +needs to be a snap in order to be able to inject itself into the containers +it starts (though this may be made more flexible in future). Use +``snapcraft`` to build the snap, which you can then install using ``snap +install --classic --dangerous lpcraft_<version>_<architecture>.snap``. +(Once ``lpcraft`` is more complete and stable, it will be made available +from the snap store.) + +You can run ``lpcraft`` from a directory containing ``.launchpad.yaml``, +although it won't do very much useful yet. + +Developing +========== + +Run tests using ``tox``. + +If you need to modify ``requirements.in``, run ``tox -e pip-compile`` +afterwards.
_______________________________________________ Mailing list: https://launchpad.net/~launchpad-reviewers Post to : [email protected] Unsubscribe : https://launchpad.net/~launchpad-reviewers More help : https://help.launchpad.net/ListHelp
