Joe LaFata avatar Joe LaFata committed f685302

Update the readme/index.rst to reduce documentation duplication

Comments (0)

Files changed (2)

 unitbench
--------------------------------------
+=========
 
-unitbench is a lightweight benchmark framework modeled after unittest.
+unitbench is a lightweight python benchmark framework.  It is
+designed to be similar to the unittest module. Recently it has been
+expanded with a function profiler.  This will allow less intrusive
+benchmarking of code.
 
 Full documentation with examples:
 http://blog.quibb.org/unitbench
 
+PyPI Page:
+http://pypi.python.org/pypi/unitbench
+
 Project Page:
 http://bitbucket.org/qbproger/unitbench
 
+Changelog
+---------
 Version 0.2:
- * added function profiler that can be used as function decorator
- * reworked the reporters to be able to work with both the function profiler and unitbenches
+ * Added function profiler that can be used as function decorator
+ * Reworked the reporters to be able to work with both the function profiler and unitbenches
+ * More information is provided by the CsvReporter
+ 
+Version 0.1:
+ * Initial release

src/doc/index.rst

    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to unitbench's documentation!
-=====================================
-
-unitbench is a lightweight python benchmark framework.  It is
-designed to be similar to the unittest module.
-
-Project Page:
-http://bitbucket.org/qbproger/unitbench
-
-PyPI Page:
-http://pypi.python.org/pypi/unitbench
-
-Please report any bugs you may find.
+.. include:: ../README.txt
 
 License
 -------
 ------------------
 
 * :ref:`genindex`
-* :ref:`modindex`
 * :ref:`search`
 
Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for ProjectModifiedEvent.java.
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.