Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

Provide more informative README for github

  • Loading branch information...
commit 95bd6aaf7172a7c147b8184c1469132bb850b29c 1 parent 53209fd
@Almad Almad authored
Showing with 84 additions and 6 deletions.
  1. +1 −1  MANIFEST.in
  2. +83 −0 README.rst
  3. +0 −5 README.txt
View
2  MANIFEST.in
@@ -1,5 +1,5 @@
include LICENSE.txt
-include README.txt
+include README.rst
include distutils_scripts/*
recursive-include paver/docs *
include paver-minilib.zip
View
83 README.rst
@@ -0,0 +1,83 @@
+==============================================
+ Paver - Easy Scripting for Software Projects
+==============================================
+
+.. image:: _static/paver_banner.jpg
+ :height: 126
+ :width: 240
+
+:Web: http://paver.github.com/paver/
+:Download: http://pypi.python.org/pypi/paver/
+:Source: http://github.com/paver/paver/
+:Keywords: build, scripting, make alternative, svn, git, path.py, documentation,
+ automation, tasks, virtualenv, integration
+
+--
+
+.. _paver-synopsis:
+
+Paver is a Python-based software project scripting tool along the lines of
+Make or Rake. It is not designed to handle the dependency tracking requirements
+of, for example, a C program. It is designed to help out with all of your other
+repetitive tasks (run documentation generators, moving files about, downloading
+things), all with the convenience of Python’s syntax and massive library of code.
+
+
+Documentation
+=============
+
+`Docs`_ are hosted on Github.
+
+.. _`Docs`: http://paver.github.com/paver/
+
+.. _paver-installation:
+
+Installation
+============
+
+You can install Paver either via the Python Package Index (PyPI)
+or from source.
+
+To install using `pip`,::
+
+ $ pip install -U Paver
+
+To install using `easy_install`::
+
+ $ easy_install -U Paver
+
+.. _getting-help:
+
+Getting Help
+============
+
+.. _mailing-list:
+
+Mailing list
+------------
+
+For any discussion about usage or development of Paver, you are welcomed to join
+the `paver mailing list`_ .
+
+.. _`paver mailing list`: http://groups.google.com/group/paver/
+
+IRC
+---
+
+Come chat with us on IRC. The `#paver`_ channel is located at the `Freenode`_
+network.
+
+.. _`#paver`: irc://irc.freenode.net/paver
+.. _`Freenode`: http://freenode.net
+
+.. _bug-tracker:
+
+Bug tracker
+===========
+
+If you have any suggestions, bug reports or annoyances please report them
+to Github `issue tracker`_.
+
+.. _`issue tracker`: http://github.com/paver/paver/issues/
+
+
View
5 README.txt
@@ -1,5 +0,0 @@
-Paver
------
-Python-based project scripting.
-
-Check the docs directory for more information.
Please sign in to comment.
Something went wrong with that request. Please try again.