Browse Source

Update documentation

Jonas Borgström 12 years ago
parent
commit
a9272ce913
5 changed files with 22 additions and 13 deletions
  1. 1 1
      MANIFEST.in
  2. 9 5
      README.rst
  3. 6 0
      docs/global.rst.inc
  4. 2 3
      docs/index.rst
  5. 4 4
      docs/installation.rst

+ 1 - 1
MANIFEST.in

@@ -1 +1 @@
-include README.rst LICENSE
+include README.rst LICENSE CHANGES MANIFEST.in

+ 9 - 5
README.rst

@@ -35,8 +35,9 @@ msgpack-python and sufficiently recent OpenSSL (>= 1.0.0).
 
 How do I install it?
 --------------------
+
 ::
-  $ python setup.py install
+  $ pip install darc
 
 Where are the docs?
 -------------------
@@ -50,7 +51,10 @@ following command::
 
   $ python -m darc.testsuite.run
 
-Where can I get help?
----------------------
-Send questions, comments, patches, etc. to jonas@borgstrom.se. Issues and
-pull requests can also be created on https://github.com/jborg/darc
+Contribute
+----------
+Found a bug? Have any ideas to improve darc? Add bug reports and feature
+requests to the `issue tracker <https://github.com/jborg/darc/issues>`_.
+
+You can also ask the author a question directly by
+`email <mailto:jonas@borgstrom.se>`_.

+ 6 - 0
docs/global.rst.inc

@@ -1,4 +1,9 @@
 .. |project_name| replace:: ``darc``
+.. |project_version| replace:: 0.6
+.. |package_dirname| replace:: darc-|project_version|
+.. |package_filename| replace:: |package_dirname|.tar.gz
+.. |package_url| replace:: https://pypi.python.org/packages/source/d/darc/darc-0.6.tar.gz
+
 .. _deduplication: https://en.wikipedia.org/wiki/Data_deduplication
 .. _AES: https://en.wikipedia.org/wiki/Advanced_Encryption_Standard
 .. _HMAC-SHA256: http://en.wikipedia.org/wiki/HMAC
@@ -9,3 +14,4 @@
 .. _Python: http://www.python.org/
 .. _`msgpack-python`: https://pypi.python.org/pypi/msgpack-python/
 .. _homebrew: http://mxcl.github.io/homebrew/
+.. _issue tracker: https://github.com/jborg/darc/issues

+ 2 - 3
docs/index.rst

@@ -56,9 +56,8 @@ User's Guide
 Contribute
 ==========
 
-Found a bug? Have any ideas to improve |project_name|?
-Head over to |project_name|'s github_ page and create an issue or a pull
-request.
+Found a bug? Have any ideas to improve |project_name|? Add bug reports and
+feature requests to the `issue tracker`_.
 
 You can also ask the author a question directly by
 `email <mailto:jonas@borgstrom.se>`_.

+ 4 - 4
docs/installation.rst

@@ -24,11 +24,11 @@ Installing from PyPI using pip
 
 Installing from source tarballs
 -------------------------------
-::
+.. parsed-literal::
 
-    $ curl -O url
-    $ tar -xvzf darc-version.tar.gz
-    $ cd darc-version
+    $ curl -O |package_url|
+    $ tar -xvzf darc-|package_filename|
+    $ cd |package_dirname|
     $ python setup.py install
 
 Installing from git