README 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. ;; PHP Cloud Files API
  2. ;; ========================================================================
  3. ;; This package contains the PHP API for the Cloud Files storage system.
  4. ;;
  5. ;; Please see http://www.rackspacecloud.com/ for more information regarding the
  6. ;; Cloud Files storage system.
  7. ;;
  8. ;; Install
  9. ;; ------------------------------------------------------------------------
  10. ;; Extract this archive and make sure the source code files are in your
  11. ;; PHP "include path". To use the API in your source code, just make
  12. ;; sure to include/require the "cloudfiles.php" script.
  13. ;;
  14. ;; Requirements
  15. ;; ------------------------------------------------------------------------
  16. ;; [mandatory] PHP version 5.x (developed against 5.2.0)
  17. ;; [mandatory] PHP's cURL module
  18. ;; [mandatory] PHP enabled with mbstring (multi-byte string) support
  19. ;; [suggested] PEAR FileInfo module (for Content-Type detection)
  20. ;;
  21. ;; Examples
  22. ;; ------------------------------------------------------------------------
  23. ;; For sample code, please see the tests and API docs.
  24. ;;
  25. ;; Docs
  26. ;; ------------------------------------------------------------------------
  27. ;; The included documentation was generated directly from the source
  28. ;; code files using the PHPDocumentor tool.
  29. ;;
  30. ;; This README file is actually the PHPDocumentor INI configuration file.
  31. ;; The following packages were installed via PEAR to generate the HTML
  32. ;; API documentation.
  33. ;;
  34. ;; * PEAR 1.4.11 (stable)
  35. ;; * PhpDocumentor 1.4.2 (stable)
  36. ;; * XML_Beautifier 1.2.0 (stable)
  37. ;; * XML_Parser 1.3.1 (stable)
  38. ;; * XML_Util 1.2.0 (stable)
  39. ;;
  40. ;; To re-generate the API docs, make sure the above software is
  41. ;; available and run:
  42. ;; rm -rf docs && phpdoc -c phpdoc.ini
  43. ;;
  44. ;; Tests
  45. ;; ------------------------------------------------------------------------
  46. ;; The tests are based on phpunit and are run with PHPUnit 3.3.17
  47. ;; please follow the instructions on :
  48. ;;
  49. ;; http://www.phpunit.de/manual/current/en/installation.html
  50. ;;
  51. ;; to install PHPUnit. When installed just run the command phpunit on
  52. ;; the top of the directory and it will launch the tests.
  53. ;;
  54. ;; The tests/Comprehensive.php is not enabled by default since
  55. ;; generating big files. If you want to run it you need to go in the
  56. ;; tests directory and run with phpunit Comprehensive.php
  57. ;;
  58. ;; ========================================================================
  59. ;; The lines below here are the configuration settings for re-generating
  60. ;; the PHP API documentation.
  61. ;;
  62. [Parse Data]
  63. title = php-cloudfiles
  64. hidden = false
  65. parseprivate = off
  66. javadocdesc = off
  67. defaultpackagename = php-cloudfiles
  68. defaultcategoryname = php-cloudfiles
  69. target = docs
  70. directory = .
  71. ignore = share/,examples/,tests/,.git/,.gitignore,*.ini,*.swp
  72. output=HTML:Smarty:PHP
  73. readmeinstallchangelog = README,COPYING,AUTHORS,Changelog