commiting to main

Author: R. S. Doiel

README.md

@@ -5,7 +5,7 @@
 
 The tools are intended to be run from the project root directory. `cmt` expects the file path of your codemeta.json file as well as one or more target files to be generated. The target file's extension determines the generated content. The tool can generate the following project files based on the contents of the codemeta.json file. `cme` expects the file path of your codemeta.json file and optionally the attributes of the CodeMeta object you wish to manage.
 
-`cme` is used to create manage "codemeta.json". `cmt` is used to generate the following.
+`cme` is used to create and manage "codemeta.json". `cmt` is used to generate the following.
 
 - CITATION.cff
 - version.ts, version.js, version.go or version.py
@@ -14,21 +14,22 @@ The tools are intended to be run from the project root directory. `cmt` expects
 
 ## Create and manage your file
 
-`cme` is for managing your "codemeta.json" file.  Using the "interactive" option it will prompt for the various top level attributes and allow you to set them. For complex list attributes like "author", "contributor", "maintainer" you can enter those using YAML notation. Here's an example of setting up to use `cme` to create and edit the "codemeta.json" file.
+`cme` is for managing your "codemeta.json" file.  If only the "codemeta.json" file is provided then you'll be in an "interactive" mode. You will be prompted for each top level attribute. You either press enter and accept the current value or replace the value. For complex attributes like "author", and "keywords"[^1] you use YAML notation followed by a line containing only a period to indicate completion. If you enter only the line with a period then the current value remains. Here's an example of setting up to use `cme` to create and edit the "codemeta.json" file.
+
+[^1]: For a full list of complex fields see the user manual for `cme`.
 
 ~~~shell
-# Set our EDITOR environment variable
-export EDITOR=micro
-cme -e -i codemeta.json
+cme codemeta.json
 ~~~
 
-The will let you iterate over the top level CodeMeta object attributes. For multi line or list attributes your favorate editor will be used to create or update the values.
+The will let you iterate over the top level CodeMeta object attributes. For multi line or list attributes your favorite editor will be used to create or update the values.
+
+Here's an example of updating the version and `.releaseNotes` attributes but instead of the direct input you edit the value using the Micro Editor[^2].
 
-Here's an example of updating the version and `.releaseNotes` attributes (I assume you have the
-EDITOR environment variable already set).
+[^2]: You need to have [Micro Editor](http://micro-editor.github.io) installed for this to work.
 
 ~~~shell
-cme -e codemeta.json version releaseNotes
+cme codemeta.json version releaseNotes -e
 ~~~
 
 Since the version is short you'll just be prompted to type in a new version string. You release notes maybe longer so for that you'll drop into your editor.

index.html

@@ -34,7 +34,7 @@ <h1 id="codemeta-tools">CodeMeta Tools</h1>
 following project files based on the contents of the codemeta.json file.
 <code>cme</code> expects the file path of your codemeta.json file and
 optionally the attributes of the CodeMeta object you wish to manage.</p>
-<p><code>cme</code> is used to create manage “codemeta.json”.
+<p><code>cme</code> is used to create and manage “codemeta.json”.
 <code>cmt</code> is used to generate the following.</p>
 <ul>
 <li>CITATION.cff</li>
@@ -43,22 +43,26 @@ <h1 id="codemeta-tools">CodeMeta Tools</h1>
 <li>page.hbs (handlebars template) or page.tmpl (Pandoc template)</li>
 </ul>
 <h2 id="create-and-manage-your-file">Create and manage your file</h2>
-<p><code>cme</code> is for managing your “codemeta.json” file. Using the
-“interactive” option it will prompt for the various top level attributes
-and allow you to set them. For complex list attributes like “author”,
-“contributor”, “maintainer” you can enter those using YAML notation.
-Here’s an example of setting up to use <code>cme</code> to create and
-edit the “codemeta.json” file.</p>
-<pre class="shell"><code># Set our EDITOR environment variable
-export EDITOR=micro
-cme -e -i codemeta.json</code></pre>
+<p><code>cme</code> is for managing your “codemeta.json” file. If only
+the “codemeta.json” file is provided then you’ll be in an “interactive”
+mode. You will be prompted for each top level attribute. You either
+press enter and accept the current value or replace the value. For
+complex attributes like “author”, and “keywords”<a href="#fn1"
+class="footnote-ref" id="fnref1" role="doc-noteref"><sup>1</sup></a> you
+use YAML notation followed by a line containing only a period to
+indicate completion. If you enter only the line with a period then the
+current value remains. Here’s an example of setting up to use
+<code>cme</code> to create and edit the “codemeta.json” file.</p>
+<pre class="shell"><code>cme codemeta.json</code></pre>
 <p>The will let you iterate over the top level CodeMeta object
-attributes. For multi line or list attributes your favorate editor will
+attributes. For multi line or list attributes your favorite editor will
 be used to create or update the values.</p>
 <p>Here’s an example of updating the version and
-<code>.releaseNotes</code> attributes (I assume you have the EDITOR
-environment variable already set).</p>
-<pre class="shell"><code>cme -e codemeta.json version releaseNotes</code></pre>
+<code>.releaseNotes</code> attributes but instead of the direct input
+you edit the value using the Micro Editor<a href="#fn2"
+class="footnote-ref" id="fnref2"
+role="doc-noteref"><sup>2</sup></a>.</p>
+<pre class="shell"><code>cme codemeta.json version releaseNotes -e</code></pre>
 <p>Since the version is short you’ll just be prompted to type in a new
 version string. You release notes maybe longer so for that you’ll drop
 into your editor.</p>
@@ -98,6 +102,19 @@ <h2 id="additional-project-documentation">Additional Project
 <li><a href="INSTALL.html">installation</a></li>
 <li><a href="LICENSE">license</a></li>
 </ul>
+<section id="footnotes" class="footnotes footnotes-end-of-document"
+role="doc-endnotes">
+<hr />
+<ol>
+<li id="fn1"><p>For a full list of complex fields see the user manual
+for <code>cme</code>.<a href="#fnref1" class="footnote-back"
+role="doc-backlink">↩︎</a></p></li>
+<li id="fn2"><p>You need to have <a
+href="http://micro-editor.github.io">Micro Editor</a> installed for this
+to work.<a href="#fnref2" class="footnote-back"
+role="doc-backlink">↩︎</a></p></li>
+</ol>
+</section>
 </section>
 </body>
 </html>

pagefind/fragment/en-US_fdfc164.pf_fragment

@@ -1 +1 @@
-{"version":"1.3.0","languages":{"en-US":{"hash":"en-US_326fe02a3ab5f","wasm":"en-US","page_count":11}}}
+{"version":"1.3.0","languages":{"en-US":{"hash":"en-US_a3c076af8c816","wasm":"en-US","page_count":11}}}

pagefind/index/en-US_9acb2bd.pf_index

@@ -9,7 +9,7 @@
   <meta name="author" content="R. S. Doiel, [email protected]" />
   <meta name="date" content="2025-01-13" />
   <meta name="keywords" content="CodeMeta, projects, build" />
-  <title>CMTools, codemeta driven builds</title>
+  <title>CMTools, CodeMeta driven builds</title>
   <style type="text/css">
     code{white-space: pre-wrap;}
     span.smallcaps{font-variant: small-caps;}
@@ -98,7 +98,7 @@
 </head>
 <body>
 <div class="slide titlepage">
-  <h1 class="title">CMTools, codemeta driven builds</h1>
+  <h1 class="title">CMTools, CodeMeta driven builds</h1>
   <p class="author">
 R. S. Doiel, <a href="mailto:[email protected]"
 class="email">[email protected]</a>
@@ -188,12 +188,12 @@ <h1>Project maintenance, old way</h1>
 <ul>
 <li>very tedious</li>
 <li>often incomplete done</li>
-<li>lower quality -&gt; higher maintainence</li>
+<li>lower quality -&gt; higher maintenance</li>
 </ul>
 </div>
 <div id="proposed-maintenance-cycle" class="slide section level1">
 <h1>Proposed maintenance cycle</h1>
-<p>One command for each supported langauge:</p>
+<p>One command for each supported language:</p>
 <ul>
 <li>Python
 <ul>
@@ -296,7 +296,7 @@ <h1>Or quick install</h1>
 <h1>Something to consider</h1>
 <blockquote>
 <p>Software lives longer than expected, long lived software requires
-maintainence</p>
+maintenance</p>
 </blockquote>
 </div>
 <div id="reference-links" class="slide section level1">

pagefind/pagefind-entry.json

@@ -1,5 +1,5 @@
 ---
-title: "CMTools, codemeta driven builds"
+title: "CMTools, CodeMeta driven builds"
 author: "R. S. Doiel, <[email protected]>"
 institute: |
   Caltech Library,
@@ -74,11 +74,11 @@ The artifact are easy to keep up to date.
 
 - very tedious
 - often incomplete done
-- lower quality -> higher maintainence
+- lower quality -> higher maintenance
 
 # Proposed maintenance cycle
 
-One command for each supported langauge:
+One command for each supported language:
 
 - Python
   - `cmt codemeta.json CITATION.cff about.md version.py`
@@ -155,7 +155,7 @@ irm https://caltechlibrary.github.io/CMTools/installer.ps1 | iex
 # Something to consider
 
 > Software lives longer than expected,
-> long lived software requires maintainence
+> long lived software requires maintenance
 
 # Reference links