From 33f828d41d9702645932a33f600f27173389dff2 Mon Sep 17 00:00:00 2001 From: Brad King <brad.king@kitware.com> Date: Tue, 13 Dec 2016 14:16:36 -0500 Subject: [PATCH] README: Convert from `.txt` to `.rst` markup Also add sections on licensing and contribution instructions. --- README.rst | 29 +++++++++++++++++++++++++++++ README.txt | 12 ------------ 2 files changed, 29 insertions(+), 12 deletions(-) create mode 100644 README.rst delete mode 100644 README.txt diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..6a594ee --- /dev/null +++ b/README.rst @@ -0,0 +1,29 @@ +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 + +Contributing +============ + +See `CONTRIBUTING.rst`_ for instructions to contribute. + +.. _`CONTRIBUTING.rst`: CONTRIBUTING.rst diff --git a/README.txt b/README.txt deleted file mode 100644 index b8191f7..0000000 --- a/README.txt +++ /dev/null @@ -1,12 +0,0 @@ -KWSys provides a platform-independent API to many common system -features that are implemented differently on every platform. This -library is intended to be shared among many projects, 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. - -You are probably reading this file in the source tree of a surrounding -project. In that case, see "../README.kwsys" for details of using -KWSys in your project. - -See CONTRIBUTING.rst for instructions to contribute KWSys changes. -- GitLab