From 7ab41ed936a6c0294edd6d9bbdd6bf790ae84cd4 Mon Sep 17 00:00:00 2001 From: Scot Hacker Date: Sat, 3 Feb 2018 00:39:59 -0800 Subject: [PATCH] Convert readme to markdown format - And remove tox references --- README.md | 15 +++++++++++++++ README.rst | 55 ------------------------------------------------------ 2 files changed, 15 insertions(+), 55 deletions(-) create mode 100644 README.md delete mode 100644 README.rst diff --git a/README.md b/README.md new file mode 100644 index 0000000..7bbd9d4 --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# django-todo + +django-todo is a pluggable, multi-user, multi-group task management and +assignment application for Django, designed to be dropped into an existing site as a reusable app. + +django-todo can serve as anything from a personal to-do tracker to a ticketing system for organizations. + +## Documentation + +For documentation, see the django-todo wiki pages: + +- [Overview and screenshots](http://github.com/shacker/django-todo/wiki/Overview-and-screenshots) +- [Requirements and installation](http://github.com/shacker/django-todo/wiki/Requirements-and-Installation) +- [Version history](http://github.com/shacker/django-todo/wiki/Version-history) + diff --git a/README.rst b/README.rst deleted file mode 100644 index 138b5e8..0000000 --- a/README.rst +++ /dev/null @@ -1,55 +0,0 @@ -============================ -django todo |latest-version| -============================ - -|build-status| |health| |downloads| |license| - -django-todo is a pluggable multi-user, multi-group task management and -assignment application for Django. It can serve as anything from a personal -to-do system to a complete, working ticketing system for organizations. - -Documentation -============= - -For documentation, see the django-todo wiki pages: - -- `Overview and screenshots - `_ - -- `Requirements and installation - `_ - -- `Version history - `_ - -Tests -===== - -Serious tests are missing, but we're checking PEP8 conformity of our syntax on -both Python 2 and 3 using ``tox``. You can run the tests locally via:: - - $ python setup.py test - -No prerequisites are required, all test dependencies will be installed -automatically by ``tox`` in virtual environments created on the fly. -Unfortunately, you'll have to install ``virtualenv`` for this to work, though. - -To remove all build files and folders including Python byte code you can run:: - - $ python setup.py clean - -.. |latest-version| image:: https://img.shields.io/pypi/v/django-todo.svg - :alt: Latest version on PyPI - :target: https://pypi.python.org/pypi/django-todo -.. |build-status| image:: https://travis-ci.org/shacker/django-todo.svg - :alt: Build status - :target: https://travis-ci.org/shacker/django-todo -.. |health| image:: https://landscape.io/github/shacker/django-todo/master/landscape.svg?style=flat - :target: https://landscape.io/github/shacker/django-todo/master - :alt: Code health -.. |downloads| image:: https://img.shields.io/pypi/dm/django-todo.svg - :alt: Monthly downloads from PyPI - :target: https://pypi.python.org/pypi/django-todo -.. |license| image:: https://img.shields.io/pypi/l/django-todo.svg - :alt: Software license - :target: https://github.com/shacker/django-todo/blob/master/LICENSE