diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 00000000..f076e71e --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,16 @@ +If you would like to contribute to the development of OpenStack, +you must follow the steps in this page: + + http://docs.openstack.org/infra/manual/developers.html + +Once those steps have been completed, changes to OpenStack +should be submitted for review via the Gerrit tool, following +the workflow documented at: + + http://docs.openstack.org/infra/manual/developers.html#development-workflow + +Pull requests submitted through GitHub will be ignored. + +Bugs should be filed on Launchpad, not GitHub: + + https://bugs.launchpad.net/python-tackerclient diff --git a/README.rst b/README.rst index a15c5839..e8d5eceb 100644 --- a/README.rst +++ b/README.rst @@ -7,4 +7,48 @@ Team and repository tags .. Change things from this point on -This is the client API library for Tacker. +NFV Orchestration (Tacker) Client +================================= + +CLI and Client Library for OpenStack Tacker + +Installation +============ + +**Note:** The paths we are using for configuration files in these steps +are with reference to Ubuntu Operating System. The paths may vary for +other Operating Systems. + +The branch_name which is used in commands, specify the branch_name +as stable/ for any stable branch installation. For eg: +stable/queens, stable/pike. If unspecified the default will be +master branch. + +1. Clone tacker-client repository. + + :: + + cd ~/ + git clone https://github.com/openstack/python-tackerclient -b + + +2. Install tacker-client. + + :: + + cd python-tackerclient + sudo python setup.py install + + +You can also install the latest version by using following command: + + :: + + pip install python-tackerclient + + +More Information +================ + +[1] Tacker Documentation: https://docs.openstack.org/tacker/ +[2] Tacker Wiki: https://wiki.openstack.org/wiki/Tacker \ No newline at end of file