Commit Graph

27 Commits

Author SHA1 Message Date
Brad King
2d42a5444f LICENSE: Rename Copyright.txt to LICENSE.rst
The name `LICENSE` is now more conventional.
Format as reStructuredText to improve rendering.
2025-03-03 09:55:56 -05:00
Brad King
8a688e556e Help/dev: Add a CMake Testing Guide
Document how developers working on CMake itself may run the test suite
locally.

Fixes: #26001
2024-06-05 12:58:47 -04:00
Brad King
aa3fffa4bb README: Drop outdated link on running CMake 2024-06-05 12:58:47 -04:00
Dave Abrahams
b46c5f2af8 README: Document non-bootstrap build instructions first
They are preferred in the now-common case that `cmake` is already
available.
2024-05-22 09:39:19 -04:00
scivision
53a542936e Help: Convert http URLs to https 2024-03-07 09:42:45 -05:00
Brad King
803a79dd69 README: Update bootstrap example to use 'build' directory under source
When the example was first written, developers commonly placed their
build trees as siblings of the source tree.  Nowadays many developers
use a `build/` directory under the top-level source directory instead.
Update the example with the modern convention to avoid requiring the
reader to understand that `cmake-source` is a placeholder for the path
to the source tree.
2023-07-27 10:15:11 -04:00
Brad King
eb705b9531 Update links to gitlab.kitware.com repos to add -/
GitLab now uses a `/-/` component between the `group/project` part of
the URL and the `{issues,merge_requests,tree}` part so that it can
support `group/subgroup/project` with arbitrary depth.
2020-05-26 11:38:01 -04:00
Brad King
d0be4d5365 README: Replace link to mailing list the CMake Discourse Forum 2019-11-06 21:45:11 +11:00
Brad King
4dd6ad20b6 README: Update links to cmake.org pages
Some of the links refer to URLs that are now redirected.  Update them.
2019-11-05 15:41:04 -05:00
Brad King
943a50da55 README: Suggest bootstrapping out-of-source for development
Building in-source and running the test suite in-source both leave
many artifacts that we (purposely) do not cover via `.gitignore`.
For developing CMake we typically use out-of-source builds, so
suggest this in the README.
2019-02-20 08:00:03 -05:00
Brad King
55ad9304ed README: Explain how to bootstrap via MSYS2 on Windows
Inspired-by: Bartosz Kosiorek <bartosz.kosiorek@tomtom.com>
2019-02-19 07:10:59 -05:00
David Demelier
33632898e9 README: Suggest "sudo" for "make install" 2018-10-17 14:09:51 -04:00
Joachim Wuttke (o)
af6f16f1e8 README: Explain how to build CMake with the docs 2018-10-09 17:57:32 +02:00
Joachim Wuttke (o)
ae80271ed3 README: Fix typo (rm space). 2018-10-09 13:26:17 +02:00
Jean-Christophe Fillion-Robin
91e4d3df15
readme: Add reference to the wiki 2018-08-01 17:08:36 -04:00
Brad King
fd4fd9a276 Require C++11 to build CMake itself
CMake can now compile as C++11 on all supported platforms.  Check that
std::unique_ptr is available and fail early if missing.  This will allow
us to use C++11 more broadly in CMake's implementation (previously it
was restricted to the serve mode implementation).

Co-Author: Daniel Pfeifer <daniel@pfeifer-mail.de>
2017-08-16 10:13:38 -04:00
Brad King
49640d3629 HP-UX: Drop support for building CMake on HP-UX
CMake will soon require both C++11 and libuv to build.  Neither of
these works on HP-UX, so unfortunately we need to drop support for
the platform until someone can get them working.

Issue: #17137
2017-08-07 09:16:09 -04:00
Brad King
acd462dd31 README: Add AIX to list of supported platforms
It was left out accidentally.
2017-08-04 09:45:03 -04:00
Brad King
bf2e4bfbaa README: Update list of supported platforms
Convert to a bullet list.  Drop platforms for which we no longer have
nightly testing.
2017-06-13 13:05:51 -04:00
Brad King
588166f804 README: Update Issue Tracker link to new location 2016-06-17 15:38:07 -04:00
Terrell Russell
6c0d8a5d02 README: Fix typo in wording 2015-10-29 09:25:52 -04:00
Brad King
da7276cf94 Replace http://www.cmake.org URLs with https://cmake.org
The latter is now the preferred URL for visiting cmake.org with a
browser.  Convert using the shell code:

 git ls-files -z | xargs -0 sed -i 's|http://www\.cmake|https://cmake|g'
2015-09-25 15:47:39 -04:00
Brad King
9aed0cd100 README: Fix typo "the the" => "the"
Reported-by: Radovan Bast
2015-07-02 09:09:33 -04:00
Brad King
d4557188bb README: Add a section explaining how to report bugs
Suggested-by: Petr Bena <benapetr@gmail.com>
2014-08-04 09:49:49 -04:00
Brad King
8da0a75ba2 Simplify and clarify credit text and link
Use the name "Kitware" rather than "Kitware, Inc." to simplify the text.
Provide a CMake-specific URL.
2014-06-03 09:24:26 -04:00
Brad King
395881f77d README: Credit Kitware and community of contributors 2014-02-03 11:10:02 -05:00
Brad King
da87549238 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.
2014-01-29 11:02:41 -05:00