diff --git a/README.rst b/README.rst index 944ffe7..37668c8 100644 --- a/README.rst +++ b/README.rst @@ -5,21 +5,25 @@ This repository will be used to house the Redfish python library, a reference implementation to enable Python developers to communicate with the Redfish API (http://www.redfishspecification.org/). -.. note: +.. sidebar:: NOTE - DRAFT - WORK IN PROGRESS The current Redfish specification revsion is 0.91 - anything and everything in this library is subject to change until the DMTF ratifies the Redfish API - standard. + standard v1.0. -Directory Structure +Project Structure ------------------- This project follows the same convention as OpenStack projects, eg. using pbr -for build and test automation. - - examples/ - tests/ +for build and test automation:: + doc/ # documentation + doc/source # the doc source files live here + doc/build/html # output of building any docs will go here + examples/ # any sample code using this library, eg. for education + # should be put here + redfish/ # the redfish library + redfish/tests/ # python unit test suite Requirements ------------ @@ -30,6 +34,10 @@ SSL verification requiring server certificates be installed. Parameters to relax the requirements are available in the library, but these configurations are discouraged due to security concerns. +Project python dependencies are listed in "requirements.txt". + +Any test-specific requirements are listed in "test-requirements.txt". + Further References ------------------