Browse Source

Documentation update.

Added links to Debian, Ubuntu and Arch linux packages and
added a comment about Cython dependency when installing from git.

Closes #21.
Jonas Borgström 11 năm trước cách đây
mục cha
commit
9c80089c04
3 tập tin đã thay đổi với 10 bổ sung0 xóa
  1. 4 0
      docs/global.rst.inc
  2. 3 0
      docs/index.rst
  3. 3 0
      docs/installation.rst

+ 4 - 0
docs/global.rst.inc

@@ -17,3 +17,7 @@
 .. _issue tracker: https://github.com/jborg/attic/issues
 .. _userspace filesystems: https://en.wikipedia.org/wiki/Filesystem_in_Userspace
 .. _librelist: http://librelist.com/
+.. _Debian: http://packages.debian.org/attic
+.. _Ubuntu: http://packages.ubuntu.com/attic
+.. _Arch Linux: https://aur.archlinux.org/packages/attic/
+.. _Cython: http://cython.org/

+ 3 - 0
docs/index.rst

@@ -24,6 +24,9 @@ You can use pip to install |project_name| quickly and easily::
 
     $ pip install attic
 
+|project_name| is also part of the Debian_, Ubuntu_ and `Arch Linux`_
+distributions of GNU/Linux.
+
 Need more help with installing? See :ref:`installation`.
 
 User's Guide

+ 3 - 0
docs/installation.rst

@@ -38,3 +38,6 @@ Installing from git
     $ git clone |git_url|
     $ cd attic
     $ python setup.py install
+
+Please not that when installing from git Cython_ is required to generate some files that
+are normally bundled with the release tarball.