cppsm init now does git init for you

polytypic · CI script · commit 05f0e9425734 · 2019-09-27T00:41:43.000+03:00
diff --git a/index.html b/index.html
@@ -192,11 +192,11 @@ <h3><a id="installation"></a> <a href="#contents">≡</a> <a href="#installation
 </ul>
 <h3><a id="quick-tour"></a> <a href="#contents">≡</a> <a href="#quick-tour">Quick tour</a></h3>
 <p>Here is a quick tour of basic <code>cppsm</code> functionality.</p>
-<p>Create a new project:</p>
+<p>Create a new empty project:</p>
 <pre><code class="hljs lang-bash">mkdir PROJECT &amp;&amp; cd &quot;$_&quot;
-git init
 cppsm init</code></pre>
-<p>Try the hello world example:</p>
+<p>At this point you could try adding dependencies or writing code, but let&#39;s
+actually try the hello world example:</p>
 <pre><code class="hljs lang-bash">cppsm init-hello
 cppsm test
 .build*/internals/hello</code></pre>
@@ -239,21 +239,23 @@ <h4><a id="cppsm-format"></a> <a href="#contents">≡</a> <a href="#cppsm-format
 <a target="_blank" href="https://clang.llvm.org/docs/ClangFormat.html">clang-format <i class="fas fa-xs fa-external-link-alt"></i></a> and
 <a target="_blank" href="https://prettier.io/">prettier <i class="fas fa-xs fa-external-link-alt"></i></a>.</p>
 <h4><a id="cppsm-init"></a> <a href="#contents">≡</a> <a href="#cppsm-init"><code>cppsm init</code></a></h4>
-<p>Initializes a new C++ project with cppsm configuration files or updates an
-existing project to use the latest configuration files. Run <code>cppsm init</code> in the
-top-level directory of a fresh git project.</p>
+<p>Initializes a new project with cppsm configuration files when run in an empty
+directory or updates an existing project to use the latest configuration files.
+See also <a href="#cppsm-init-hello"><code>cppsm init-hello</code></a> and
+<a href="#cppsm-init-library"><code>cppsm init-library</code></a>.</p>
 <p>Configuration variables:</p>
 <ul>
 <li><p><a id="init-name"></a><a href="#init-name"><code>NAME=&#39;...&#39;</code></a> specifies the base name for
 the project and defaults to the name of the current directory.</p>
 </li>
 <li><p><a id="init-version"></a><a href="#init-version"><code>VERSION=&#39;v1&#39;|&#39;...&#39;</code></a> specifies the
-version suffix for the project.</p>
+branch and version suffix for the project.</p>
 </li>
 </ul>
 <h4><a id="cppsm-init-hello"></a> <a href="#contents">≡</a> <a href="#cppsm-init-hello"><code>cppsm init-hello</code></a></h4>
-<p>Creates an example &quot;Hello, world!&quot; program in a freshly initialized project
-directory.</p>
+<p>Initializes a new project with an example &quot;Hello, world!&quot; program. This is only
+intended for educational purposes. See also <a href="#cppsm-init"><code>cppsm init</code></a> and
+<a href="#cppsm-init-library"><code>cppsm init-library</code></a>.</p>
 <pre><code>CMakeLists.txt
 equipment/
   testing.cpp/
@@ -278,8 +280,9 @@ <h4><a id="cppsm-init-hello"></a> <a href="#contents">≡</a> <a href="#cppsm-in
       hello.hpp
   library/
     hello.cpp</code></pre><h4><a id="cppsm-init-library"></a> <a href="#contents">≡</a> <a href="#cppsm-init-library"><code>cppsm init-library</code></a></h4>
-<p>Creates boilerplate for a simple library project with tests in a freshly
-initialized project directory.</p>
+<p>Initializes a new project with boilerplate for a simple library project in an
+empty directory. See also <a href="#cppsm-init"><code>cppsm init</code></a> and
+<a href="#cppsm-init-hello"><code>cppsm init-hello</code></a>.</p>
 <pre><code>CMakeLists.txt
 internals/
   CMakeLists.txt
diff --git a/index.md b/index.md
@@ -159,15 +159,15 @@ Optional dependencies:
 
 Here is a quick tour of basic `cppsm` functionality.
 
-Create a new project:
+Create a new empty project:
 
 ```bash
 mkdir PROJECT && cd "$_"
-git init
 cppsm init
 ```
 
-Try the hello world example:
+At this point you could try adding dependencies or writing code, but let's
+actually try the hello world example:
 
 ```bash
 cppsm init-hello
@@ -255,22 +255,24 @@ Formats project files inplace using
 
 #### <a id="cppsm-init"></a> [≡](#contents) [`cppsm init`](#cppsm-init)
 
-Initializes a new C++ project with cppsm configuration files or updates an
-existing project to use the latest configuration files. Run `cppsm init` in the
-top-level directory of a fresh git project.
+Initializes a new project with cppsm configuration files when run in an empty
+directory or updates an existing project to use the latest configuration files.
+See also [`cppsm init-hello`](#cppsm-init-hello) and
+[`cppsm init-library`](#cppsm-init-library).
 
 Configuration variables:
 
 - <a id="init-name"></a>[`NAME='...'`](#init-name) specifies the base name for
   the project and defaults to the name of the current directory.
 
 - <a id="init-version"></a>[`VERSION='v1'|'...'`](#init-version) specifies the
-  version suffix for the project.
+  branch and version suffix for the project.
 
 #### <a id="cppsm-init-hello"></a> [≡](#contents) [`cppsm init-hello`](#cppsm-init-hello)
 
-Creates an example "Hello, world!" program in a freshly initialized project
-directory.
+Initializes a new project with an example "Hello, world!" program. This is only
+intended for educational purposes. See also [`cppsm init`](#cppsm-init) and
+[`cppsm init-library`](#cppsm-init-library).
 
     CMakeLists.txt
     equipment/
@@ -299,8 +301,9 @@ directory.
 
 #### <a id="cppsm-init-library"></a> [≡](#contents) [`cppsm init-library`](#cppsm-init-library)
 
-Creates boilerplate for a simple library project with tests in a freshly
-initialized project directory.
+Initializes a new project with boilerplate for a simple library project in an
+empty directory. See also [`cppsm init`](#cppsm-init) and
+[`cppsm init-hello`](#cppsm-init-hello).
 
     CMakeLists.txt
     internals/
