PageRenderTime 23ms CodeModel.GetById 17ms RepoModel.GetById 0ms app.codeStats 0ms

/lib/simplepie/README.markdown

http://github.com/moodle/moodle
Markdown | 113 lines | 86 code | 27 blank | 0 comment | 0 complexity | 959cc2ecd7ebb4c403a8dfadebf5dbdb MD5 | raw file
Possible License(s): MIT, AGPL-3.0, MPL-2.0-no-copyleft-exception, LGPL-3.0, GPL-3.0, Apache-2.0, LGPL-2.1, BSD-3-Clause 
    

  1. SimplePie
    2. 

  2. =========
    3. 

  3. 

  4. SimplePie is a very fast and easy-to-use class, written in PHP, that puts the
    5. 

  5. 'simple' back into 'really simple syndication'.  Flexible enough to suit
    6. 

  6. beginners and veterans alike, SimplePie is focused on [speed, ease of use,
    7. 

  7. compatibility and standards compliance][what_is].
    8. 

  8. 

  9. [what_is]: http://simplepie.org/wiki/faq/what_is_simplepie
    10. 

  10. 

  11. 

  12. Requirements
    13. 

  13. ------------
    14. 

  14. * PHP 5.3.0+ (5.3.6+ recommended since SimplePie 1.4.2)
    15. 

  15. 	* Support for PHP 5.2 stopped in branch `one-dot-three`
    16. 

  16. 	* Support for PHP 4 stopped in branch `one-dot-two`
    17. 

  17. * libxml2 (certain 2.7.x releases are too buggy for words, and will crash)
    18. 

  18. * One of iconv, mbstring or intl extensions
    19. 

  19. * cURL or fsockopen()
    20. 

  20. * PCRE support
    21. 

  21. 

  22. 

  23. What comes in the package?
    24. 

  24. --------------------------
    25. 

  25. 1. `library/` - SimplePie classes for use with the autoloader
    26. 

  26. 2. `autoloader.php` - The SimplePie Autoloader if you want to use the separate
    27. 

  27.    file version.
    28. 

  28. 3. `README.markdown` - This document.
    29. 

  29. 4. `LICENSE.txt` - A copy of the BSD license.
    30. 

  30. 5. `compatibility_test/` - The SimplePie compatibility test that checks your
    31. 

  31.    server for required settings.
    32. 

  32. 6. `demo/` - A basic feed reader demo that shows off some of SimplePie's more
    33. 

  33.    noticeable features.
    34. 

  34. 7. `idn/` - A third-party library that SimplePie can optionally use to
    35. 

  35.    understand Internationalized Domain Names (IDNs).
    36. 

  36. 8. `build/` - Scripts related to generating pieces of SimplePie
    37. 

  37. 9. `test/` - SimplePie's unit test suite.
    38. 

    39. 

  39. ### Where's `simplepie.inc`?
    40. 

  40. Since SimplePie 1.3, we've split the classes into separate files to make it easier
    41. 

  41. to maintain and use.
    42. 

  42. 

  43. If you'd like a single monolithic file, you can run `php build/compile.php` to
    44. 

  44. generate `SimplePie.compiled.php`.
    45. 

  45. 

  46. To start the demo
    47. 

  47. -----------------
    48. 

  48. 1. Upload this package to your webserver.
    49. 

  49. 2. Make sure that the cache folder inside of the demo folder is server-writable.
    50. 

  50. 3. Navigate your browser to the demo folder.
    51. 

  51. 

  52. 

  53. Need support?
    54. 

  54. -------------
    55. 

  55. For further setup and install documentation, function references, etc., visit
    56. 

  56. [the wiki][wiki]. If you're using the latest version off GitHub, you can also
    57. 

  57. check out the [API documentation][].
    58. 

  58. 

  59. If you can't find an answer to your question in the documentation, head on over
    60. 

  60. to one of our [support channels][]. For bug reports and feature requests, visit
    61. 

  61. the [issue tracker][].
    62. 

  62. 

  63. [API documentation]: http://dev.simplepie.org/api/
    64. 

  64. [wiki]: http://simplepie.org/wiki/
    65. 

  65. [support channels]: http://simplepie.org/support/
    66. 

  66. [issue tracker]: http://github.com/simplepie/simplepie/issues
    67. 

  67. 

  68. 

  69. Project status
    70. 

  70. --------------
    71. 

  71. SimplePie is currently maintained by Malcolm Blaney.
    72. 

  72. 

  73. As an open source project, SimplePie is maintained on a somewhat sporadic basis.
    74. 

  74. This means that feature requests may not be fulfilled straight away, as time has
    75. 

  75. to be prioritized.
    76. 

  76. 

  77. If you'd like to contribute to SimplePie, the best way to get started is to fork
    78. 

  78. the project on GitHub and send pull requests for patches. When doing so, please
    79. 

  79. be aware of our [coding standards][].
    80. 

  80. 

  81. [coding standards]: http://simplepie.org/wiki/misc/coding_standards
    82. 

  82. 

  83. 

  84. Authors and contributors
    85. 

  85. ------------------------
    86. 

  86. ### Current
    87. 

  87. * [Malcolm Blaney][] (Maintainer, support)
    88. 

  88. 

  89. ### Alumni
    90. 

  90. * [Ryan McCue][] (developer, support)
    91. 

  91. * [Ryan Parman][] (Creator, developer, evangelism, support)
    92. 

  92. * [Geoffrey Sneddon][] (Lead developer)
    93. 

  93. * [Michael Shipley][] (Submitter of patches, support)
    94. 

  94. * [Steve Minutillo][] (Submitter of patches)
    95. 

  95. 

  96. [Malcolm Blaney]: https://unicyclic.com/mal
    97. 

  97. [Ryan McCue]: http://ryanmccue.info
    98. 

  98. [Ryan Parman]: http://ryanparman.com
    99. 

  99. [Geoffrey Sneddon]: http://gsnedders.com
    100. 

  100. [Michael Shipley]: http://michaelpshipley.com
    101. 

  101. [Steve Minutillo]: http://minutillo.com/steve/
    102. 

  102. 

  103. 

  104. ### Contributors
    105. 

  105. For a complete list of contributors:
    106. 

  106. 

  107. 1. Pull down the latest SimplePie code
    108. 

  108. 2. In the `simplepie` directory, run `git shortlog -ns`
    109. 

  109. 

  110. 

  111. License
    112. 

  112. -------
    113. 

  113. [New BSD license](http://www.opensource.org/licenses/BSD-3-Clause)
    114. 

  114.