diff --git a/README b/README deleted file mode 100644 index 14c89b3..0000000 --- a/README +++ /dev/null @@ -1,21 +0,0 @@ -================== -django-admin-tools -================== - -django-admin-tools is a collection of extensions/tools for the default django -administration interface, it includes: - - * a full featured and customizable dashboard, - * a customizable menu bar, - * tools to make admin theming easier. - -The project code and bugtracker is hosted on -`Bitbucket `_. - -Django-admin-tools is generously documented, you can -`browse the documentation online -`_. -a good start is to read `the quickstart guide -`_. - -Thanks for downloading django-admin-tools. diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..9371014 --- /dev/null +++ b/README.rst @@ -0,0 +1,92 @@ +django-admin-tools +================== + +.. image:: https://travis-ci.org/django-admin-tools/django-admin-tools.svg?branch=master + :target: https://travis-ci.org/django-admin-tools/django-admin-tools + + +django-admin-tools is a collection of extensions/tools for the default django +administration interface, it includes: + +* a full featured and customizable dashboard; +* a customizable menu bar; +* tools to make admin theming easier. + +The code is hosted on `Github `_. + +Django-admin-tools is generously documented, you can +`browse the documentation online +`_. +a good start is to read `the quickstart guide +`_. + +The project was created by `David Jean Louis `_ and was previously hosted on `Bitbucket `_. + +Please join the `mailing list `_ if you want to discuss of the future of django-admin-tools. + +************ +Installation +************ + +To install django-admin-tools, run the following command inside this directory: + + python setup.py install + +If you have the Python **easy_install** utility available, you can also type +the following to download and install in one step:: + + easy_install django-admin-tools + +Or if you're using **pip**:: + + pip install django-admin-tools + +Or if you'd prefer you can simply place the included "admin_tools" directory +somewhere on your python path, or symlink to it from somewhere on your Python +path; this is useful if you're working from a Mercurial checkout. + +An `installation guide `_ is available in the documentation. + +************* +Documentation +************* + +`Extensive documentation `_ is available, it was made with the excellent `Sphinx program `_ + +************ +Translations +************ + +There is a `a transifex project `_ for django-admin-tools. + +************ +Screenshots +************ + +The django admin login screen: + +.. image:: http://www.izimobil.org/django-admin-tools/images/capture-1.png + :alt: The django admin login screen + + +The admin index dashboard: + +.. image:: http://www.izimobil.org/django-admin-tools/images/capture-2.png + :alt: The admin index dashboard + + +The admin menu: + +.. image:: http://www.izimobil.org/django-admin-tools/images/capture-3.png + :alt: The admin menu + +Dashboard modules can be dragged, collapsed, closed etc.: + +.. image:: http://www.izimobil.org/django-admin-tools/images/capture-4.png + :alt: Dashboard modules can be dragged, collapsed, closed etc. + +The app index dashboard: + +.. image:: http://www.izimobil.org/django-admin-tools/images/capture-5.png + :alt: The app index dashboard +