openstack
/
murano-pkg-check
Code Issues Proposed changes

Readme has now some running examples 

Change-Id: Iecfe3275c51bd06d9483c0d09864a98a39d87166
This commit is contained in:
Krzysztof Szukiełojć 2016-10-04 09:41:48 +02:00
parent 73bc5f1e00
commit ef9e96d05f
1 changed files with 22 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
README.rst
View File

@ -4,16 +4,31 @@ murano-pkg-check
Murano package validator tool
Please fill here a long description which must be at least 3 lines wrapped on
80 cols, so that distribution package maintainers can use it in their packages.
Note that this is a hard requirement.
After checking out tool from repository easiest method to run tool is to run
.. code-block:: shell
tox -e venv -- murano-pkg-check -h
This command will display help for murano-pkg-validator
If you installed it from PYPI you can use:
.. code-block:: shell
murano-pkg-check -h
To run validator in directory apache-app just run:
.. code-block:: shell
murano-pkg-check apache-app
It will print all errors there are on package.
.. code-block:: shell
murano-pkg-check --discovery murano-apps
Will search for all packages under directory `murano-apps`. It will print all
errors and warnings for all packages found.
* Free software: Apache license
* Documentation: http://docs.openstack.org/developer/murano-pkg-check
* Source: http://git.openstack.org/cgit/openstack/murano-pkg-check
* Bugs: http://bugs.launchpad.net/murano-pkg-check
Features
--------
* TODO