Add build status badge to README
[pyxattr.git] / README.rst
1 pyxattr
2 =======
3
4 This is the pyxattr module, a Python extension module which gives access
5 to the extended attributes for filesystem objects available in some
6 operating systems.
7
8 Downloads: go to http://pyxattr.k1024.org/downloads/. Latest
9 version is 0.5.6. The source repository is either at
10 http://git.k1024.org/pyxattr.git or at
11 https://github.com/iustin/pyxattr.
12
13 [![Build Status](https://travis-ci.org/iustin/pyxattr.svg?branch=master)](https://travis-ci.org/iustin/pyxattr)
14
15 Requirements
16 ------------
17
18 pyxattr has been written and tested on Linux, kernel v2.4 or later, with
19 XFS filesystems; ext2/ext3 should work also. If any other platform
20 implements the same behavior, pyxattr could be used.
21
22 You need to have the attr library (including development headers; most
23 distributions should have this, under various names) and setuptools
24 installed in order to build and install the module.
25
26 License
27 -------
28
29 pyxattr is Copyright 2002-2008, 2012-2015 Iustin Pop.
30
31 pyxattr is free software; you can redistribute it and/or modify it under the
32 terms of the GNU Lesser General Public License as published by the Free
33 Software Foundation; either version 2.1 of the License, or (at your option) any
34 later version. See the COPYING file for the full license terms.
35
36 Note that previous versions had different licenses: version 0.3 was licensed
37 under LGPL version 3 (which, I realized later, is not compatible with GPLv2,
38 hence the change to LGPL 2.1), and even older versions were licensed under GPL
39 v2 or later.
40
41 .. Local Variables:
42 .. mode: rst
43 .. fill-column: 72
44 .. End: