diff options
| author | Jonas Borgström <jonas@borgstrom.se> | 2013-07-08 21:19:50 +0200 |
|---|---|---|
| committer | Jonas Borgström <jonas@borgstrom.se> | 2013-07-08 21:19:50 +0200 |
| commit | a9272ce913974548e2944ab6e11a1bc308619808 (patch) | |
| tree | 8fc9d9126aa9ca59f5c9ab27aedd9fbc0b9ec02b | |
| parent | e578d28184f609242c0d7f7f647659063bac8fa8 (diff) | |
Update documentation
| -rw-r--r-- | MANIFEST.in | 2 | ||||
| -rw-r--r-- | README.rst | 14 | ||||
| -rw-r--r-- | docs/global.rst.inc | 6 | ||||
| -rw-r--r-- | docs/index.rst | 5 | ||||
| -rw-r--r-- | docs/installation.rst | 8 |
5 files changed, 22 insertions, 13 deletions
diff --git a/MANIFEST.in b/MANIFEST.in index 0c738421d..e2e9d05ec 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -1 +1 @@ -include README.rst LICENSE +include README.rst LICENSE CHANGES MANIFEST.in diff --git a/README.rst b/README.rst index 47a900f44..825a460f0 100644 --- a/README.rst +++ b/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>`_. diff --git a/docs/global.rst.inc b/docs/global.rst.inc index accfa51a0..87cc77e94 100644 --- a/docs/global.rst.inc +++ b/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 diff --git a/docs/index.rst b/docs/index.rst index 34e92284f..423dcf525 100644 --- a/docs/index.rst +++ b/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>`_. diff --git a/docs/installation.rst b/docs/installation.rst index ab7041abd..52e0258ed 100644 --- a/docs/installation.rst +++ b/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 |