summaryrefslogtreecommitdiffstats
path: root/README.rst
diff options
context:
space:
mode:
authorKWSys Upstream <kwrobot@kitware.com>2016-12-14 16:15:00 (GMT)
committerBrad King <brad.king@kitware.com>2016-12-14 16:16:55 (GMT)
commita9ea66bd66db0f0ad9b0b59d617739ad6a04cebf (patch)
tree48fe0a559802900eedf43abc38d483f65f270abc /README.rst
parent1b50bd3f5c1f608a84df89c2f5e187a53f0be31d (diff)
downloadCMake-a9ea66bd66db0f0ad9b0b59d617739ad6a04cebf.zip
CMake-a9ea66bd66db0f0ad9b0b59d617739ad6a04cebf.tar.gz
CMake-a9ea66bd66db0f0ad9b0b59d617739ad6a04cebf.tar.bz2
KWSys 2016-12-14 (95a7e234)
Code extracted from: https://gitlab.kitware.com/utils/kwsys.git at commit 95a7e234ffd0c6bdfaa8b21c59a119198c050164 (master). Upstream Shortlog ----------------- Ben Boeckel (1): e0967411 Add a script to help update third-party sources Brad King (10): 98505f79 Add script to update GitSetup from upstream 365edba8 GitSetup: Tell Git not to export .gitattributes 41a7fe5b Add pre-commit hook to check whether SetupForDevelopment must re-run 17a1200c Convert developer setup scripts away from Gerrit Code Review 5f206c3a Tell Git to use a distinct conflict marker size in `.rst` files 33f828d4 README: Convert from `.txt` to `.rst` markup 56b707dd README: Add section about reporting bugs 140357ea CONTRIBUTING: Document contribution through the Kitware GitLab Instance 4b7bf8e4 Tell Git not to export any `.sh` or `.bash` scripts e25eb8dc CONTRIBUTING: Add step for running developer setup script GitSetup Upstream (3): fed3d191 GitSetup 2012-09-27 (341043cf) a0144297 GitSetup 2016-12-13 (8af10838) 868c1e68 GitSetup 2016-12-13 (cd5ada6d)
Diffstat (limited to 'README.rst')
-rw-r--r--README.rst37
1 files changed, 37 insertions, 0 deletions
diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000..fc6b590
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,37 @@
+KWSys
+*****
+
+Introduction
+============
+
+KWSys is the Kitware System Library. It provides platform-independent
+APIs to many common system features that are implemented differently on
+every platform. This library is intended to be shared among many
+projects at the source level, so it has a configurable namespace.
+Each project should configure KWSys to use a namespace unique to itself.
+See comments in `CMakeLists.txt`_ for details.
+
+.. _`CMakeLists.txt`: CMakeLists.txt
+
+License
+=======
+
+KWSys is distributed under the OSI-approved BSD 3-clause License.
+See `Copyright.txt`_ for details.
+
+.. _`Copyright.txt`: Copyright.txt
+
+Reporting Bugs
+==============
+
+KWSys has no independent issue tracker. After encountering an issue
+(bug) please submit a patch using the instructions for `Contributing`_.
+Otherwise please report the issue to the tracker for the project that
+hosts the copy of KWSys in which the problem was found.
+
+Contributing
+============
+
+See `CONTRIBUTING.rst`_ for instructions to contribute.
+
+.. _`CONTRIBUTING.rst`: CONTRIBUTING.rst