cmake: Recommend native CMake commands in README #1483

1. 
   real-or-random commented at 2:25 pm on January 17, 2024: contributor

   Resolves one item in #1235. Closes #1294.

   cc @hebasto

2. cmake: Recommend native CMake commands in README

   Resolves one item in #1235. Closes #1294.

   3777e3f36a
3. real-or-random added the label user-documentation on Jan 17, 2024
4. real-or-random added the label build on Jan 17, 2024
5. real-or-random cross-referenced this on Jan 17, 2024 from issue build: Meta-issue for follow-ups to initial CMake merge (#1113) by hebasto
6. in README.md:81 in 3777e3f36a

   78@@ -79,9 +79,9 @@ To maintain a pristine source tree, CMake encourages to perform an out-of-source
   79 
   80     $ mkdir build && cd build
   81     $ cmake ..
   

   ---

   ---

   

   hebasto commented at 11:08 am on January 18, 2024:

   nit: Might be explicit:

   0    $ cmake -S ..
   

   ?

   ---

   

   real-or-random commented at 2:17 pm on January 18, 2024:

   Hm, yeah, I think shorter is better, and omitting the -S is also more common. (See the official tutorial https://cmake.org/cmake/help/latest/guide/tutorial/A%20Basic%20Starting%20Point.html for example.)

   ---

   

   hebasto commented at 3:32 pm on January 18, 2024:

   OK, nm.
7. in README.md:84 in 3777e3f36a

   78@@ -79,9 +79,9 @@ To maintain a pristine source tree, CMake encourages to perform an out-of-source
   79 
   80     $ mkdir build && cd build
   81     $ cmake ..
   82-    $ make
   83-    $ make check  # run the test suite
   84-    $ sudo make install  # optional
   85+    $ cmake --build .
   86+    $ ctest  # run the test suite
   87+    $ sudo cmake --build . --target install  # optional
   

   ---

   ---

   

   hebasto commented at 11:10 am on January 18, 2024:

   Is it worth mentioning a modern and more effective alternative, which is available for CMake >= 3.15:

   0$ sudo cmake --install .  # optional
   

   ?

   ---

   

   real-or-random commented at 2:19 pm on January 18, 2024:

   Thanks for the suggestion. In fact, I had this first, but I changed to the current form because we still support CMake 3.13.

   ---

   

   hebasto commented at 3:33 pm on January 18, 2024:

   I mean, mention it additionally, not instead of the current line.

   ---

   

   hebasto commented at 3:34 pm on January 18, 2024:

   However, it’s OK in its current view.
8. hebasto approved
9. 
   hebasto commented at 11:11 am on January 18, 2024: member

   ACK 3777e3f36a61a05da19d5c6575fdd59288848948
10. jonasnick approved
11. 
    jonasnick commented at 7:34 pm on January 23, 2024: contributor

    ACK 3777e3f36a61a05da19d5c6575fdd59288848948
12. jonasnick merged this on Jan 23, 2024
13. jonasnick closed this on Jan 23, 2024

    ---

Contributors
real-or-random hebasto jonasnick

Labels
user-documentation build