aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTim Harder <radhermit@gmail.com>2016-03-06 01:00:33 -0500
committerTim Harder <radhermit@gmail.com>2016-03-06 01:00:33 -0500
commit00bc4cdc3e36ad9dbdad7792607bb17ad2c68dbf (patch)
tree03ac552a8c083989fb6499d74e45ad01272e5b4b /README.rst
parentmove snakeoil.lists to snakeoil.sequences (diff)
downloadpkgcore-00bc4cdc3e36ad9dbdad7792607bb17ad2c68dbf.tar.gz
pkgcore-00bc4cdc3e36ad9dbdad7792607bb17ad2c68dbf.tar.bz2
pkgcore-00bc4cdc3e36ad9dbdad7792607bb17ad2c68dbf.zip
readme: various header changes
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst22
1 files changed, 12 insertions, 10 deletions
diff --git a/README.rst b/README.rst
index eb3a2a3d..51cd5583 100644
--- a/README.rst
+++ b/README.rst
@@ -1,7 +1,8 @@
|pypi| |test| |coverage| |docs|
-What is pkgcore?
-================
+=======
+pkgcore
+=======
pkgcore is a framework for package management; via the appropriate class
plugins, the design should allow for any underlying repository/config/format to
@@ -11,18 +12,19 @@ manager in each package (pkgcore *does* require being able to treat the pkg as
data, instead of autopackage's method of handing resolution/all manager ops off
to the package script).
-What does pkgcore require?
-==========================
+Requirements
+============
At least python version 2.7, and snakeoil_ — a utility library with misc
optimizations split out of pkgcore for others to use. For unittests, mock_ is
required if you're using anything less than python 3.3.
-Who to contact if I find a bug?
-===============================
+Contact
+=======
-Please submit an issue via Github_. You can also send an email to the dev list
-(pkgcore-dev@googlegroups.com) or stop by `#pkgcore`_ on Freenode.
+For support and development inquiries join `#pkgcore`_ on Freenode.
+
+For bugs and feature requests please create an issue on Github_.
Tools
=====
@@ -46,8 +48,8 @@ Tools
Documentation
=============
-The official documentation can be found on readthedocs_ with alternative
-formats also available for download_.
+Official documentation is provided on readthedocs_ with alternative
+formats available for download_.
Tests
=====