From 36f776df9993aade39059884a441bb61b91e3b4c Mon Sep 17 00:00:00 2001 From: Adam Voss Date: Tue, 13 Jun 2017 11:11:01 -0500 Subject: [PATCH] Moves DEPENDENCIES to CONTRIBUTING.md and updates links --- CONTRIBUTING.md | 19 +++++++++++++++++++ DEPENDENCIES | 31 ------------------------------- MANIFEST.in | 2 +- 3 files changed, 20 insertions(+), 32 deletions(-) create mode 100644 CONTRIBUTING.md delete mode 100644 DEPENDENCIES diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2620a4a --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,19 @@ +# HARD DEPENDENCIES + +If you have a Python version lower than Python 2.6 (which already includes +simplejson as the "json" module), you will need to install simplejson from + + - [simplejson](https://github.com/simplejson/simplejson) + +# OPTIONAL DEPENDENCIES + +If you want to run the UNIT TESTS ("make test"), you also need + + - [Nose](http://readthedocs.org/docs/nose/) + - [MiniMock](http://pypi.python.org/pypi/MiniMock) + - [Coverage](http://coverage.readthedocs.io/en/latest/) + +If you want to generate the API DOCS ("make docs"), you also need + + - [Epydoc](http://epydoc.sourceforge.net/) + diff --git a/DEPENDENCIES b/DEPENDENCIES deleted file mode 100644 index 42594b9..0000000 --- a/DEPENDENCIES +++ /dev/null @@ -1,31 +0,0 @@ -============================================================================== - HARD DEPENDENCIES -============================================================================== - -If you have a Python version lower than Python 2.6 (which already includes -simplejson as the "json" module), you will need to install simplejson from - - simplejson (python-simplejson) - http://code.google.com/p/simplejson/ - - -============================================================================== - OPTIONAL DEPENDENCIES -============================================================================== - -If you want to run the UNIT TESTS ("make test"), you also need - - Nose (python-nose) - http://somethingaboutorange.com/mrl/projects/nose/ - - MiniMock (python-minimock) - http://pypi.python.org/pypi/MiniMock - - Coverage (python-coverage) - http://www.nedbatchelder.com/code/modules/coverage.html - -If you want to generate the API DOCS ("make docs"), you also need - - Epydoc (python-epydoc) - http://epydoc.sourceforge.net/ - diff --git a/MANIFEST.in b/MANIFEST.in index 4ff7d39..c9c61d7 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1,5 +1,5 @@ include AUTHORS include COPYING -include DEPENDENCIES +include CONTRIBUTING.md include NEWS include makefile