From 8de5171ab01132af791f96a8577bf532d843abdc Mon Sep 17 00:00:00 2001 From: Iustin Pop Date: Sun, 13 May 2012 06:12:34 +0200 Subject: [PATCH] Integrate old web site index file into README MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit … and include the README into the main docs page. --- Makefile | 2 +- README | 41 +++++++++++++++++++++++++++++++++++++++++ README.md | 23 ----------------------- doc/index.rst | 11 ++++++++--- 4 files changed, 50 insertions(+), 27 deletions(-) create mode 100644 README delete mode 100644 README.md diff --git a/Makefile b/Makefile index 034fed0..41e203e 100644 --- a/Makefile +++ b/Makefile @@ -6,7 +6,7 @@ DOCTREES = $(DOCDIR)/doctrees ALLSPHINXOPTS = -d $(DOCTREES) $(SPHINXOPTS) $(DOCDIR) MODNAME = posix1e.so -RSTFILES = doc/index.rst doc/module.rst NEWS doc/conf.py +RSTFILES = doc/index.rst doc/module.rst NEWS README doc/conf.py all: doc test diff --git a/README b/README new file mode 100644 index 0000000..7b42b08 --- /dev/null +++ b/README @@ -0,0 +1,41 @@ +pylibacl +======== + +This is a Python 2.4+ extension module allows you to manipulate the +POSIX.1e Access Control Lists present in some OS/file-systems +combinations. + +Downloads: go to https://github.com/iustin/pylibacl/downloads. Latest +version is 0.5.1. The source repository is either +at ``_ or +at https://github.com/iustin/pylibacl. + +For any issues, please file bugs at +https://github.com/iustin/pylibacl/issues. + +Requirements +------------ + +pylibacl has been written and tested on Linux, kernel v2.4 or newer, +with XFS filesystems; ext2/ext3 should also work. Since release 0.4.0, +FreeBSD 7 also has quite good support. If any other platform +implements the POSIX.1e draft, pylibacl can be used. I heard that +Solaris does, but I can't test it yet. + +- Python 2.4 or newer +- operating system: + - Linux, kernel v2.4 or newer, and the libacl library and + development packages (all modern distributions should have this, + under various names); also the file-systems you use must have + ACLs turned on, either as a compile or mount option + - FreeBSD 7.0 or newer + +License +------- + +pylibacl is Copyright (C) 2002-2009, 2012 Iustin Pop. + +pylibacl is free software; you can redistribute it and/or modify it under the +terms of the GNU Lesser General Public License as published by the Free +Software Foundation; either version 2.1 of the License, or (at your option) any +later version. See the COPYING file for the full license terms. diff --git a/README.md b/README.md deleted file mode 100644 index 3d7abf5..0000000 --- a/README.md +++ /dev/null @@ -1,23 +0,0 @@ -pylibacl -======== - -About ------ - -This is an extension for Python which implements POSIX ACLs (POSIX.1e). - -The supported platforms are detailed in the file PLATFORMS. - -A few internal details are in the file IMPLEMENTATION. - -License -------- - -pylibacl is Copyright (C) 2002-2009, 2012 Iustin Pop. - -pylibacl is free software; you can redistribute it and/or modify it under the -terms of the GNU Lesser General Public License as published by the Free -Software Foundation; either version 2.1 of the License, or (at your option) any -later version. See the COPYING file for the full license terms. - -Iustin Pop, diff --git a/doc/index.rst b/doc/index.rst index 63eb4ff..8eb5db6 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,7 +1,12 @@ -Welcome to pylibacl's documentation! -==================================== +====================================== + Welcome to pylibacl's documentation! +====================================== -Contents: +.. include:: ../README + :start-line: 2 + +Contents +-------- .. toctree:: :maxdepth: 2 -- 2.39.5