From da87549238b3ac57f6365be975e6301041ab5178 Mon Sep 17 00:00:00 2001
From: Brad King <brad.king@kitware.com>
Date: Wed, 29 Jan 2014 10:56:27 -0500
Subject: Update README and add guidelines for CONTRIBUTING

Rename 'Readme.txt' to 'README.rst', format the documentation as
reStructuredText, and modernize the content.  Also add a new
'CONTRIBUTING.rst' explaining the preferred entry path for new
contributors.
---
 README.rst | 78 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 78 insertions(+)
 create mode 100644 README.rst

(limited to 'README.rst')

diff --git a/README.rst b/README.rst
new file mode 100644
index 0000000000..6be9aa8021
--- /dev/null
+++ b/README.rst
@@ -0,0 +1,78 @@
+CMake
+*****
+
+Introduction
+============
+
+CMake is a cross-platform, open-source build system generator.
+For full documentation visit the `CMake Home Page`_ and the
+`CMake Documentation Page`_.
+
+.. _`CMake Home Page`: http://www.cmake.org
+.. _`CMake Documentation Page`: http://www.cmake.org/cmake/help/documentation.html
+
+License
+=======
+
+CMake is distributed under the OSI-approved BSD 3-clause License.
+See `Copyright.txt`_ for details.
+
+.. _`Copyright.txt`: Copyright.txt
+
+Building CMake
+==============
+
+Supported Platforms
+-------------------
+
+MS Windows, Mac OS X, Linux, FreeBSD, Solaris, HP-UX, IRIX, BeOS, QNX
+
+Other UNIX-like operating systems may work too out of the box, if not
+it should not be a major problem to port CMake to this platform.
+Subscribe and post to the `CMake Users List`_ to ask if others have
+had experience with the platform.
+
+.. _`CMake Users List`: http://www.cmake.org/mailman/listinfo/cmake
+
+Building CMake from Scratch
+---------------------------
+
+UNIX/Mac OSX/MinGW/MSYS/Cygwin
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+You need to have a compiler and a make installed.
+Run the ``bootstrap`` script you find the in the source directory of CMake.
+You can use the ``--help`` option to see the supported options.
+You may use the ``--prefix=<install_prefix>`` option to specify a custom
+installation directory for CMake. You can run the ``bootstrap`` script from
+within the CMake source directory or any other build directory of your
+choice. Once this has finished successfully, run ``make`` and
+``make install``.  In summary::
+
+ $ ./bootstrap && make && make install
+
+Windows
+^^^^^^^
+
+You need to download and install a binary release of CMake in order to build
+CMake.  You can get these releases from the `CMake Download Page`_ .  Then
+proceed with the instructions below.
+
+.. _`CMake Download Page`: http://www.cmake.org/cmake/resources/software.html
+
+Building CMake with CMake
+-------------------------
+
+You can build CMake as any other project with a CMake-based build system:
+run the installed CMake on the sources of this CMake with your preferred
+options and generators. Then build it and install it.
+For instructions how to do this, see documentation on `Running CMake`_.
+
+.. _`Running CMake`: http://www.cmake.org/cmake/help/runningcmake.html
+
+Contributing
+============
+
+See `CONTRIBUTING.rst`_ for instructions to contribute.
+
+.. _`CONTRIBUTING.rst`: CONTRIBUTING.rst
-- 
cgit v1.2.1