From fd7798d254838e9621bc1d4da75909c8dbacf046 Mon Sep 17 00:00:00 2001 From: Marko Kreen Date: Thu, 14 Jul 2016 18:13:37 +0300 Subject: [PATCH] Sync readme and docs --- README.rst | 13 ++++--------- doc/index.rst | 18 +++++++++--------- 2 files changed, 13 insertions(+), 18 deletions(-) diff --git a/README.rst b/README.rst index 596ca91..a356407 100644 --- a/README.rst +++ b/README.rst @@ -8,7 +8,7 @@ license. Features: -- Supports both RAR2 and RAR3 archives (WinRAR 2.x .. WinRAR 4.x). +- Supports both RAR3 and RAR5 format archives. - Supports multi volume archives. - Supports Unicode filenames. - Supports password-protected archives. @@ -18,22 +18,17 @@ Features: from RARLAB_ or ``bsdtar`` from libarchive_. - Works with both Python 2.7 and 3.x. -Notes: - -- Does not support the RAR5 format introduced in WinRAR 5.0. -- ``bsdtar`` does not support all RAR3 features. - Links: - `Documentation`_ - `Downloads`_ - `Git`_ repo -.. _RAR: https://en.wikipedia.org/wiki/RAR_%28file_format%29 -.. _zipfile: https://docs.python.org/2/library/zipfile.html -.. _ISC: https://en.wikipedia.org/wiki/ISC_license .. _Git: https://github.com/markokr/rarfile .. _Downloads: https://pypi.python.org/pypi/rarfile .. _Documentation: https://rarfile.readthedocs.io/ +.. _RAR: https://en.wikipedia.org/wiki/RAR_%28file_format%29 +.. _zipfile: https://docs.python.org/2/library/zipfile.html +.. _ISC: https://en.wikipedia.org/wiki/ISC_license .. _libarchive: https://github.com/libarchive/libarchive .. _RARLAB: http://www.rarlab.com/ diff --git a/doc/index.rst b/doc/index.rst index bbd4a51..473d62d 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -6,22 +6,17 @@ This is Python module for RAR_ archive reading. The interface is made as zipfile_ like as possible. Licensed under ISC_ license. -.. _RAR: http://en.wikipedia.org/wiki/RAR -.. _zipfile: http://docs.python.org/library/zipfile.html -.. _ISC: http://en.wikipedia.org/wiki/ISC_license - Features: -- Supports both RAR 2.x and 3.x archives. +- Supports both RAR3 and RAR5 format archives. - Supports multi volume archives. - Supports Unicode filenames. - Supports password-protected archives. - Supports archive and file comments. - Archive parsing and non-compressed files are handled in pure Python code. -- For compressed files runs ``unrar`` utility. -- Works with both Python 2.x and 3.x. - - +- Compressed files are extracted by executing external tool: either ``unrar`` + from RARLAB_ or ``bsdtar`` from libarchive_. +- Works with both Python 2.7 and 3.x. Documentation: @@ -40,3 +35,8 @@ Indices and tables * :ref:`modindex` * :ref:`search` +.. _RAR: http://en.wikipedia.org/wiki/RAR +.. _zipfile: http://docs.python.org/library/zipfile.html +.. _ISC: http://en.wikipedia.org/wiki/ISC_license +.. _libarchive: https://github.com/libarchive/libarchive +.. _RARLAB: http://www.rarlab.com/ -- 2.11.4.GIT