weekly release 4.0dev+
[moodle.git] / lib / simplepie / README.markdown
1 SimplePie
2 =========
4 SimplePie is a very fast and easy-to-use class, written in PHP, that puts the
5 'simple' back into 'really simple syndication'.  Flexible enough to suit
6 beginners and veterans alike, SimplePie is focused on [speed, ease of use,
7 compatibility and standards compliance][what_is].
9 [what_is]: http://simplepie.org/wiki/faq/what_is_simplepie
12 Requirements
13 ------------
14 * PHP 5.6+ (Required since SimplePie 1.5.3)
15 * libxml2 (certain 2.7.x releases are too buggy for words, and will crash)
16 * One of iconv, mbstring or intl extensions
17 * cURL or fsockopen()
18 * PCRE support
21 What comes in the package?
22 --------------------------
23 1. `library/` - SimplePie classes for use with the autoloader
24 2. `autoloader.php` - The SimplePie Autoloader if you want to use the separate
25    file version.
26 3. `README.markdown` - This document.
27 4. `LICENSE.txt` - A copy of the BSD license.
28 5. `compatibility_test/` - The SimplePie compatibility test that checks your
29    server for required settings.
30 6. `demo/` - A basic feed reader demo that shows off some of SimplePie's more
31    noticeable features.
32 7. `idn/` - A third-party library that SimplePie can optionally use to
33    understand Internationalized Domain Names (IDNs).
34 8. `build/` - Scripts related to generating pieces of SimplePie
35 9. `test/` - SimplePie's unit test suite.
37 ### Where's `simplepie.inc`?
38 Since SimplePie 1.3, we've split the classes into separate files to make it easier
39 to maintain and use.
41 If you'd like a single monolithic file, you can run `php build/compile.php` to
42 generate `SimplePie.compiled.php`.
44 To start the demo
45 -----------------
46 1. Upload this package to your webserver.
47 2. Make sure that the cache folder inside of the demo folder is server-writable.
48 3. Navigate your browser to the demo folder.
51 Need support?
52 -------------
53 For further setup and install documentation, function references, etc., visit
54 [the wiki][wiki]. If you're using the latest version off GitHub, you can also
55 check out the [API documentation][].
57 If you can't find an answer to your question in the documentation, head on over
58 to one of our [support channels][]. For bug reports and feature requests, visit
59 the [issue tracker][].
61 [API documentation]: http://dev.simplepie.org/api/
62 [wiki]: http://simplepie.org/wiki/
63 [support channels]: http://simplepie.org/support/
64 [issue tracker]: http://github.com/simplepie/simplepie/issues
67 Project status
68 --------------
69 SimplePie is currently maintained by Malcolm Blaney.
71 As an open source project, SimplePie is maintained on a somewhat sporadic basis.
72 This means that feature requests may not be fulfilled straight away, as time has
73 to be prioritized.
75 If you'd like to contribute to SimplePie, the best way to get started is to fork
76 the project on GitHub and send pull requests for patches. When doing so, please
77 be aware of our [coding standards][].
79 [coding standards]: http://simplepie.org/wiki/misc/coding_standards
82 Authors and contributors
83 ------------------------
84 ### Current
85 * [Malcolm Blaney][] (Maintainer, support)
87 ### Alumni
88 * [Ryan McCue][] (developer, support)
89 * [Ryan Parman][] (Creator, developer, evangelism, support)
90 * [Sam Sneddon][] (Lead developer)
91 * [Michael Shipley][] (Submitter of patches, support)
92 * [Steve Minutillo][] (Submitter of patches)
94 [Malcolm Blaney]: https://mblaney.xyz
95 [Ryan McCue]: http://ryanmccue.info
96 [Ryan Parman]: http://ryanparman.com
97 [Sam Sneddon]: https://gsnedders.com
98 [Michael Shipley]: http://michaelpshipley.com
99 [Steve Minutillo]: http://minutillo.com/steve/
102 ### Contributors
103 For a complete list of contributors:
105 1. Pull down the latest SimplePie code
106 2. In the `simplepie` directory, run `git shortlog -ns`
109 License
110 -------
111 [New BSD license](http://www.opensource.org/licenses/BSD-3-Clause)