Commit 19ecb166 authored by Petrus J.v.Rensburg's avatar Petrus J.v.Rensburg

Add Installation ans Testing sections to README.

parent 1e9f71b2
...@@ -20,3 +20,5 @@ __pycache__ ...@@ -20,3 +20,5 @@ __pycache__
examples/sqla-inline/static examples/sqla-inline/static
examples/file/files examples/file/files
examples/forms/files examples/forms/files
.DS_Store
.idea/
\ No newline at end of file
...@@ -20,6 +20,38 @@ anything, every single aspect of the library can be customized. ...@@ -20,6 +20,38 @@ anything, every single aspect of the library can be customized.
Flask-Admin is evolving project, extensively tested and production ready. Flask-Admin is evolving project, extensively tested and production ready.
Installation
------------
To install Flask-Admin, simply::
pip install flask-admin
Or alternatively, you can download the repository and install manually by doing::
cd flask-admin
python setup.py install
Tests
-----
Test are run with *nose*. If you are not familiar with this package you can get some more info from `their website <http://nose.readthedocs.org/`_.
To run the tests, simply
pip install nose
and then
cd flask-admin
nosetests
You should see output such as:
----------------------------------------------------------------------
Ran 41 tests in 2.092s
Please note that you will need to install some additional dependencies in order for all of the tests to be executed successfully.
Documentation Documentation
------------- -------------
...@@ -30,9 +62,9 @@ Flask-Admin is extensively documented, you can find `documentation here <http:// ...@@ -30,9 +62,9 @@ Flask-Admin is extensively documented, you can find `documentation here <http://
Flask-Admin is built with the help of `Twitter Bootstrap <http://twitter.github.com/bootstrap/>`_ and `Select2 <https://github.com/ivaynberg/select2>`_. Flask-Admin is built with the help of `Twitter Bootstrap <http://twitter.github.com/bootstrap/>`_ and `Select2 <https://github.com/ivaynberg/select2>`_.
If you want to localize administrative interface, install `Flask-BabelEx <https://pypi.python.org/pypi/Flask-BabelEx>` package. If you want to localize administrative interface, install `Flask-BabelEx <https://pypi.python.org/pypi/Flask-BabelEx>`_ package.
Examples Examples
-------- --------
The library comes with a quite a few examples, you can find them in the `examples <https://github.com/mrjoes/flask-admin/tree/master/examples>` directory. The library comes with a quite a few examples, you can find them in the `examples <https://github.com/mrjoes/flask-admin/tree/master/examples>`_ directory.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment