Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
paltman committed Jul 2, 2014
1 parent ebd2b68 commit 827453c
Showing 1 changed file with 40 additions and 68 deletions.
108 changes: 40 additions & 68 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,69 +1,41 @@
pinax-starter-app
=================


Quickly setup the scaffolding for your django app.

What you get:

* test infrastructure
* Travis configuration with coveralls
* documentation instrastructure
* MIT LICENSE
* setup.py


Getting Started
================

Execute::

pip install Django
django-admin.py startapp --template=https://github.com/pinax/pinax-starter-app/zipball/master --extension=py,rst,in,sh,rc,yml,ini,coveragerc <project_name>


After you are running you have a fresh app, first update this readme by removing
everything above and including this line and unindenting everything below this line. Also
remember to edit the ``<user_or_org_name>`` in the travis and coveralls badge/links::

wiki
========================
.. image:: https://travis-ci.org/<user_or_org_name>/pinax-wiki.png
:target: https://travis-ci.org/<user_or_org_name>/pinax-wiki
.. image:: https://coveralls.io/repos/<user_or_org_name>/pinax-wiki/badge.png
:target: https://coveralls.io/r/<user_or_org_name>/pinax-wiki
.. image:: https://pypip.in/d/pinax-wiki/badge.png
:target: https://pypi.python.org/pypi/pinax-wiki/
.. image:: https://pypip.in/v/pinax-wiki/badge.png
:target: https://pypi.python.org/pypi/pinax-wiki/
.. image:: https://pypip.in/license/pinax-wiki/badge.png
:target: https://pypi.python.org/pypi/pinax-wiki/
Welcome to the documentation for pinax-wiki!
Running the Tests
------------------------------------
You can run the tests with via::
python setup.py test
or::
make test
or::
make all
or::
python runtests.py
pinax-wiki
========================

.. image:: https://travis-ci.org/pinax/pinax-wiki.png
:target: https://travis-ci.org/pinax/pinax-wiki

.. image:: https://coveralls.io/repos/pinax/pinax-wiki/badge.png
:target: https://coveralls.io/r/pinax/pinax-wiki

.. image:: https://pypip.in/d/pinax-wiki/badge.png
:target: https://pypi.python.org/pypi/pinax-wiki/

.. image:: https://pypip.in/v/pinax-wiki/badge.png
:target: https://pypi.python.org/pypi/pinax-wiki/

.. image:: https://pypip.in/license/pinax-wiki/badge.png
:target: https://pypi.python.org/pypi/pinax-wiki/


Welcome to the documentation for pinax-wiki!


Running the Tests
------------------------------------

You can run the tests with via::

python setup.py test

or::

make test

or::

make all

or::

python runtests.py

0 comments on commit 827453c

Please sign in to comment.