Skip to content

Commit

Permalink
README, added file extension .rst ( to be displayed on github). added…
Browse files Browse the repository at this point in the history
… badges.

--HG--
rename : README => README.rst
  • Loading branch information
schettino72 committed Feb 19, 2014
1 parent 3dc12ea commit 45acac8
Showing 1 changed file with 28 additions and 8 deletions.
36 changes: 28 additions & 8 deletions README → README.rst
Expand Up @@ -2,6 +2,20 @@
README README
================ ================


.. display some badges
.. image:: https://pypip.in/v/doit/badge.png
:target: https://pypi.python.org/pypi/doit

.. image:: https://pypip.in/d/doit/badge.png
:target: https://pypi.python.org/pypi/doit

.. image:: https://travis-ci.org/pydoit/doit.png?branch=master
:target: https://travis-ci.org/pydoit/doit

.. image:: https://coveralls.io/repos/pydoit/doit/badge.png?branch=master
:target: https://coveralls.io/r/pydoit/doit?branch=master



doit - automation tool doit - automation tool
====================== ======================
Expand Down Expand Up @@ -36,7 +50,7 @@ see AUTHORS file
install install
======= =======


doit is tested on python 2.6, 2.7, 3.2, 3.3. doit is tested on python 2.6, 2.7, 3.2, 3.3, 3.4.


$ python setup.py install $ python setup.py install


Expand Down Expand Up @@ -105,8 +119,19 @@ To create it (after installing doit):
The website will also includes epydoc generated API documentation. The website will also includes epydoc generated API documentation.




github mirror contributing
=============== ==============

On bitbucket create pull requests on `default` branch.

On github create pull requests using a named feature branch.


github mirror setup
=====================

This is only needed if you will manage both upstream in github and bitbucket.
For using github only just use `git` normaly and ignore it is a mirror.


* install hg-git (http://hg-git.github.io/) `sudo pip install hg-git`. * install hg-git (http://hg-git.github.io/) `sudo pip install hg-git`.


Expand All @@ -125,8 +150,3 @@ github mirror


$ hg push github $ hg push github



continuous integration
==========================

travis - https://travis-ci.org/pydoit/doit

0 comments on commit 45acac8

Please sign in to comment.