README.txt 761 B

12345678910111213141516171819202122
  1. -------
  2. Summary
  3. -------
  4. WebBasics is a set of classes that provides the minimal functionalities of a
  5. website. The core exists of a class autoloader, a template parser, a logger
  6. and some array manipulation functions. No MVC 'model' implementation is
  7. included, there are already many of these out there (PHPActiveRecord is
  8. recommended).
  9. ----------
  10. Unit tests
  11. ----------
  12. Unit tests are in the 'tests/' directory. PHPUnit is used to run tests. The
  13. PHP extension Xdebug needs to be installed in order to generate a code
  14. coverage report. To run all unit tests, simply run 'phpunit' in the root
  15. directory.
  16. -------------
  17. Documentation
  18. -------------
  19. PhpDocumentor can be used to generate documentation in the 'docs/' directory.
  20. Just run 'phpdoc' in the root directory.