README: document the make_a_release.sh script
authorArtem Bityutskiy <artem.bityutskiy@intel.com>
Thu, 15 Aug 2013 07:01:40 +0000 (10:01 +0300)
committerArtem Bityutskiy <artem.bityutskiy@intel.com>
Thu, 15 Aug 2013 07:01:40 +0000 (10:01 +0300)
Change-Id: Ie90e707d2546d66064a6ec9af61ce6216984b1a2
Signed-off-by: Artem Bityutskiy <artem.bityutskiy@intel.com>
docs/README

index b8aabaa..3199511 100644 (file)
@@ -50,6 +50,8 @@ The project structure
 | - setup.cfg            | contains a piece of nose tests configuration        |
 | - .coveragerc          | lists files to include into test coverage report    |
 | - TODO                 | Just a list of things to be done for the project.   |
+| - make_a_release.sh    | Most people may ignore this script. It is used by   |
+|                        | maintainer when creating a new release.
 | - tests/               | Contains the project unit-tests.                    |
 |   | - test_api_base.py | Tests the base API modules: 'BmapCreate.py' and     |
 |   |                    | 'BmapCopy.py'.                                      |