README.rst 1.0 KB

12345678910111213141516171819202122232425262728293031323334353637
  1. KWSys
  2. *****
  3. Introduction
  4. ============
  5. KWSys is the Kitware System Library. It provides platform-independent
  6. APIs to many common system features that are implemented differently on
  7. every platform. This library is intended to be shared among many
  8. projects at the source level, so it has a configurable namespace.
  9. Each project should configure KWSys to use a namespace unique to itself.
  10. See comments in `CMakeLists.txt`_ for details.
  11. .. _`CMakeLists.txt`: CMakeLists.txt
  12. License
  13. =======
  14. KWSys is distributed under the OSI-approved BSD 3-clause License.
  15. See `Copyright.txt`_ for details.
  16. .. _`Copyright.txt`: Copyright.txt
  17. Reporting Bugs
  18. ==============
  19. KWSys has no independent issue tracker. After encountering an issue
  20. (bug) please submit a patch using the instructions for `Contributing`_.
  21. Otherwise please report the issue to the tracker for the project that
  22. hosts the copy of KWSys in which the problem was found.
  23. Contributing
  24. ============
  25. See `CONTRIBUTING.rst`_ for instructions to contribute.
  26. .. _`CONTRIBUTING.rst`: CONTRIBUTING.rst