Document init-library and init-hello (#4)

polytypic · web-flow · commit 5a2f5011b651 · 2019-09-20T02:36:52.000+03:00
diff --git a/index.html b/index.html
@@ -42,8 +42,13 @@ <h2><a id="contents"></a> <a href="#contents">≡</a> <a href="#contents">Conten
 <li><a href="#cppsm-build-watch"><code>cppsm build-watch</code></a></li>
 <li><a href="#cppsm-clone"><code>cppsm clone &lt;url&gt; &lt;branch&gt;</code></a></li>
 <li><a href="#cppsm-format"><code>cppsm format</code></a></li>
-<li><a href="#cppsm-hello"><code>cppsm hello</code></a></li>
-<li><a href="#cppsm-init"><code>cppsm init</code></a></li>
+<li><a href="#cppsm-init"><code>cppsm init</code></a><ul>
+<li><a href="#init-name"><code>NAME=&#39;...&#39;</code></a></li>
+<li><a href="#init-version"><code>VERSION=&#39;v1&#39;|&#39;...&#39;</code></a></li>
+</ul>
+</li>
+<li><a href="#cppsm-init-hello"><code>cppsm init-hello</code></a></li>
+<li><a href="#cppsm-init-library"><code>cppsm init-library</code></a></li>
 <li><a href="#cppsm-list"><code>cppsm list</code></a></li>
 <li><a href="#cppsm-remove"><code>cppsm remove &lt;path&gt;</code></a></li>
 <li><a href="#cppsm-setup"><code>cppsm setup</code></a><ul>
@@ -120,8 +125,8 @@ <h2><a id="project-structure"></a> <a href="#contents">≡</a> <a href="#project
 <li>any number of executable tests in the <code>testing</code> directory, and</li>
 <li>an executable program in the <code>program</code> directory.</li>
 </ul>
-<p>Try the <code>cppsm hello</code> script. It generates a simple example project that has
-essentially the following structure:</p>
+<p>Try the <code>cppsm init-hello</code> script. It generates a simple example project that
+has essentially the following structure:</p>
 <pre><code>CMakeLists.txt
 equipment/
   testing.cpp/
@@ -173,8 +178,8 @@ <h3><a id="quick-tour"></a> <a href="#contents">≡</a> <a href="#quick-tour">Qu
 <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 (after <code>init</code>):</p>
-<pre><code class="hljs lang-bash">cppsm hello
+<p>Try the hello world example:</p>
+<pre><code class="hljs lang-bash">cppsm init-hello
 cppsm test
 .build*/internals/hello</code></pre>
 <p>Start hacking:</p>
@@ -215,14 +220,35 @@ <h4><a id="cppsm-format"></a> <a href="#contents">≡</a> <a href="#cppsm-format
 <p>Formats project files inplace using
 <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-hello"></a> <a href="#contents">≡</a> <a href="#cppsm-hello"><code>cppsm hello</code></a></h4>
-<p>Creates an example &quot;Hello, world!&quot; program in a freshly initialized project
-directory.</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>
-<h4><a id="cppsm-list"></a> <a href="#contents">≡</a> <a href="#cppsm-list"><code>cppsm list</code></a></h4>
+<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>
+</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>
+<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>
+<pre><code>CMakeLists.txt
+internals/
+  CMakeLists.txt
+  testing/
+    compile_synopsis_test.cpp
+provides/
+  CMakeLists.txt
+  include/
+    ${NAME}_${VERSION}/
+      synopsis.hpp</code></pre><h4><a id="cppsm-list"></a> <a href="#contents">≡</a> <a href="#cppsm-list"><code>cppsm list</code></a></h4>
 <p>Prints out a dependency tree of submodules. This command exits with an error
 code in case any problems are found in the dependency tree.</p>
 <h4><a id="cppsm-remove"></a> <a href="#contents">≡</a> <a href="#cppsm-remove"><code>cppsm remove &lt;path&gt;</code></a></h4>
diff --git a/index.md b/index.md
@@ -34,8 +34,11 @@ See [repositories with the `#cppsm` topic](https://github.com/topics/cppsm).
     - [`cppsm build-watch`](#cppsm-build-watch)
     - [`cppsm clone <url> <branch>`](#cppsm-clone)
     - [`cppsm format`](#cppsm-format)
-    - [`cppsm hello`](#cppsm-hello)
     - [`cppsm init`](#cppsm-init)
+      - [`NAME='...'`](#init-name)
+      - [`VERSION='v1'|'...'`](#init-version)
+    - [`cppsm init-hello`](#cppsm-init-hello)
+    - [`cppsm init-library`](#cppsm-init-library)
     - [`cppsm list`](#cppsm-list)
     - [`cppsm remove <path>`](#cppsm-remove)
     - [`cppsm setup`](#cppsm-setup)
@@ -94,8 +97,8 @@ A single _target directory_ may simultaneously contain
 - any number of executable tests in the `testing` directory, and
 - an executable program in the `program` directory.
 
-Try the `cppsm hello` script. It generates a simple example project that has
-essentially the following structure:
+Try the `cppsm init-hello` script. It generates a simple example project that
+has essentially the following structure:
 
     CMakeLists.txt
     equipment/
@@ -171,10 +174,10 @@ git init
 cppsm init
 ```
 
-Try the hello world example (after `init`):
+Try the hello world example:
 
 ```bash
-cppsm hello
+cppsm init-hello
 cppsm test
 .build*/internals/hello
 ```
@@ -257,17 +260,41 @@ Formats project files inplace using
 [clang-format](https://clang.llvm.org/docs/ClangFormat.html) and
 [prettier](https://prettier.io/).
 
-#### <a id="cppsm-hello"></a> [≡](#contents) [`cppsm hello`](#cppsm-hello)
-
-Creates an example "Hello, world!" program in a freshly initialized project
-directory.
-
 #### <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.
 
+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.
+
+#### <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.
+
+#### <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.
+
+    CMakeLists.txt
+    internals/
+      CMakeLists.txt
+      testing/
+        compile_synopsis_test.cpp
+    provides/
+      CMakeLists.txt
+      include/
+        ${NAME}_${VERSION}/
+          synopsis.hpp
+
 #### <a id="cppsm-list"></a> [≡](#contents) [`cppsm list`](#cppsm-list)
 
 Prints out a dependency tree of submodules. This command exits with an error
