mirror of https://github.com/borgbackup/borg.git
Update documentation
This commit is contained in:
parent
e578d28184
commit
a9272ce913
|
@ -1 +1 @@
|
||||||
include README.rst LICENSE
|
include README.rst LICENSE CHANGES MANIFEST.in
|
||||||
|
|
14
README.rst
14
README.rst
|
@ -35,8 +35,9 @@ msgpack-python and sufficiently recent OpenSSL (>= 1.0.0).
|
||||||
|
|
||||||
How do I install it?
|
How do I install it?
|
||||||
--------------------
|
--------------------
|
||||||
|
|
||||||
::
|
::
|
||||||
$ python setup.py install
|
$ pip install darc
|
||||||
|
|
||||||
Where are the docs?
|
Where are the docs?
|
||||||
-------------------
|
-------------------
|
||||||
|
@ -50,7 +51,10 @@ following command::
|
||||||
|
|
||||||
$ python -m darc.testsuite.run
|
$ python -m darc.testsuite.run
|
||||||
|
|
||||||
Where can I get help?
|
Contribute
|
||||||
---------------------
|
----------
|
||||||
Send questions, comments, patches, etc. to jonas@borgstrom.se. Issues and
|
Found a bug? Have any ideas to improve darc? Add bug reports and feature
|
||||||
pull requests can also be created on https://github.com/jborg/darc
|
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>`_.
|
||||||
|
|
|
@ -1,4 +1,9 @@
|
||||||
.. |project_name| replace:: ``darc``
|
.. |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
|
.. _deduplication: https://en.wikipedia.org/wiki/Data_deduplication
|
||||||
.. _AES: https://en.wikipedia.org/wiki/Advanced_Encryption_Standard
|
.. _AES: https://en.wikipedia.org/wiki/Advanced_Encryption_Standard
|
||||||
.. _HMAC-SHA256: http://en.wikipedia.org/wiki/HMAC
|
.. _HMAC-SHA256: http://en.wikipedia.org/wiki/HMAC
|
||||||
|
@ -9,3 +14,4 @@
|
||||||
.. _Python: http://www.python.org/
|
.. _Python: http://www.python.org/
|
||||||
.. _`msgpack-python`: https://pypi.python.org/pypi/msgpack-python/
|
.. _`msgpack-python`: https://pypi.python.org/pypi/msgpack-python/
|
||||||
.. _homebrew: http://mxcl.github.io/homebrew/
|
.. _homebrew: http://mxcl.github.io/homebrew/
|
||||||
|
.. _issue tracker: https://github.com/jborg/darc/issues
|
||||||
|
|
|
@ -56,9 +56,8 @@ User's Guide
|
||||||
Contribute
|
Contribute
|
||||||
==========
|
==========
|
||||||
|
|
||||||
Found a bug? Have any ideas to improve |project_name|?
|
Found a bug? Have any ideas to improve |project_name|? Add bug reports and
|
||||||
Head over to |project_name|'s github_ page and create an issue or a pull
|
feature requests to the `issue tracker`_.
|
||||||
request.
|
|
||||||
|
|
||||||
You can also ask the author a question directly by
|
You can also ask the author a question directly by
|
||||||
`email <mailto:jonas@borgstrom.se>`_.
|
`email <mailto:jonas@borgstrom.se>`_.
|
||||||
|
|
|
@ -24,11 +24,11 @@ Installing from PyPI using pip
|
||||||
|
|
||||||
Installing from source tarballs
|
Installing from source tarballs
|
||||||
-------------------------------
|
-------------------------------
|
||||||
::
|
.. parsed-literal::
|
||||||
|
|
||||||
$ curl -O url
|
$ curl -O |package_url|
|
||||||
$ tar -xvzf darc-version.tar.gz
|
$ tar -xvzf darc-|package_filename|
|
||||||
$ cd darc-version
|
$ cd |package_dirname|
|
||||||
$ python setup.py install
|
$ python setup.py install
|
||||||
|
|
||||||
Installing from git
|
Installing from git
|
||||||
|
|
Loading…
Reference in New Issue