update docs

automation-tasks-rs · May 1, 2024 · 8508143 · 8508143
1 parent f57ccd8
commit 8508143
Show file tree

Hide file tree

Showing 83 changed files with 514 additions and 26,539 deletions.
diff --git a/docs/cargo_auto/all.html b/docs/cargo_auto/all.html
@@ -33,7 +33,7 @@
     <div class="sidebar-crate">
       <a class="logo-container" href="../cargo_auto/index.html"><img src=
       "https://github.com/automation-tasks-rs/cargo-auto/raw/main/images/logo/logo_cargo_auto.svg" alt="logo"></a>
-      <h2><a href="../cargo_auto/index.html">cargo_auto</a><span class="version">2024.501.55</span></h2>
+      <h2><a href="../cargo_auto/index.html">cargo_auto</a><span class="version">2024.501.1827</span></h2>
     </div>
     <div class="sidebar-elems">
       <section>

diff --git a/docs/cargo_auto/fn.main.html b/docs/cargo_auto/fn.main.html
@@ -34,7 +34,7 @@
     <div class="sidebar-crate">
       <a class="logo-container" href="../cargo_auto/index.html"><img src=
       "https://github.com/automation-tasks-rs/cargo-auto/raw/main/images/logo/logo_cargo_auto.svg" alt="logo"></a>
-      <h2><a href="../cargo_auto/index.html">cargo_auto</a><span class="version">2024.501.55</span></h2>
+      <h2><a href="../cargo_auto/index.html">cargo_auto</a><span class="version">2024.501.1827</span></h2>
     </div>
     <div class="sidebar-elems"></div>
   </nav>
@@ -59,7 +59,7 @@ <h2><a href="../cargo_auto/index.html">cargo_auto</a><span class="version">2024.
         <div class="main-heading">
           <h1>Function <a href="index.html">cargo_auto</a>::<wbr><a class="fn" href="#">main</a><button id="copy-path" title=
           "Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt=
-          "Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/cargo_auto/main.rs.html#259-270">source</a> · <button id=
+          "Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/cargo_auto/main.rs.html#257-268">source</a> · <button id=
           "toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span>
         </div>
         <pre class="rust item-decl"><code>pub(crate) fn main()</code></pre>

diff --git a/docs/cargo_auto/index.html b/docs/cargo_auto/index.html
@@ -34,7 +34,7 @@
     <div class="sidebar-crate">
       <a class="logo-container" href="../cargo_auto/index.html"><img src=
       "https://github.com/automation-tasks-rs/cargo-auto/raw/main/images/logo/logo_cargo_auto.svg" alt="logo"></a>
-      <h2><a href="../cargo_auto/index.html">cargo_auto</a><span class="version">2024.501.55</span></h2>
+      <h2><a href="../cargo_auto/index.html">cargo_auto</a><span class="version">2024.501.1827</span></h2>
     </div>
     <div class="sidebar-elems">
       <ul class="block">
@@ -72,7 +72,7 @@ <h2><a href="../cargo_auto/index.html">cargo_auto</a><span class="version">2024.
         <div class="main-heading">
           <h1>Crate <a class="mod" href="#">cargo_auto</a><button id="copy-path" title="Copy item path to clipboard"><img src=
           "../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src"
-          href="../src/cargo_auto/main.rs.html#4-270">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span>
+          href="../src/cargo_auto/main.rs.html#4-268">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span>
         </div>
         <details class="toggle top-doc" open="">
           <summary class="hideme">
@@ -81,7 +81,7 @@ <h1>Crate <a class="mod" href="#">cargo_auto</a><button id="copy-path" title="Co
           <div class="docblock">
             <h2 id="cargo-auto"><a class="doc-anchor" href="#cargo-auto">§</a>cargo-auto</h2>
             <p><strong>Automation tasks coded in Rust language for the workflow of Rust projects</strong><br>
-            <em><strong>version: 2024.501.55 date: 2024-05-01 author: <a href="https://bestia.dev">bestia.dev</a> repository: <a href=
+            <em><strong>version: 2024.501.1827 date: 2024-05-01 author: <a href="https://bestia.dev">bestia.dev</a> repository: <a href=
             "https://github.com/automation-tasks-rs/cargo-auto">GitHub</a></strong></em></p>
             <p><img src="https://img.shields.io/badge/maintained-green" alt="maintained"> <img src="https://img.shields.io/badge/ready_for_use-green" alt=
             "ready-for-use"> <img src="https://img.shields.io/badge/rustlang-orange" alt="rustlang"> <img src="https://img.shields.io/badge/automation-orange"
@@ -98,13 +98,13 @@ <h2 id="cargo-auto"><a class="doc-anchor" href="#cargo-auto">§</a>cargo-auto</h
             "https://github.com/automation-tasks-rs/cargo-auto/workflows/rust_fmt_auto_build_test/badge.svg" alt="Rust"></a> <a href=
             "https://automation-tasks-rs.github.io/cargo-auto/cargo_auto/index.html"><img src="https://img.shields.io/badge/newest_docs-blue.svg" alt=
             "Newest docs"></a> <img src="https://bestia.dev/webpage_hit_counter/get_svg_image/959103982.svg" alt="cargo-auto"></p>
-            <p><a href="https://github.com/automation-tasks-rs/cargo-auto/"><img src="https://img.shields.io/badge/Lines_in_Rust-2565-green.svg" alt=
+            <p><a href="https://github.com/automation-tasks-rs/cargo-auto/"><img src="https://img.shields.io/badge/Lines_in_Rust-1299-green.svg" alt=
             "Lines in Rust code"></a> <a href="https://github.com/automation-tasks-rs/cargo-auto/"><img src=
-            "https://img.shields.io/badge/Lines_in_Doc_comments-1159-blue.svg" alt="Lines in Doc comments"></a> <a href=
-            "https://github.com/automation-tasks-rs/cargo-auto/"><img src="https://img.shields.io/badge/Lines_in_comments-615-purple.svg" alt=
+            "https://img.shields.io/badge/Lines_in_Doc_comments-742-blue.svg" alt="Lines in Doc comments"></a> <a href=
+            "https://github.com/automation-tasks-rs/cargo-auto/"><img src="https://img.shields.io/badge/Lines_in_comments-222-purple.svg" alt=
             "Lines in Comments"></a> <a href="https://github.com/automation-tasks-rs/cargo-auto/"><img src=
             "https://img.shields.io/badge/Lines_in_examples-0-yellow.svg" alt="Lines in examples"></a> <a href=
-            "https://github.com/automation-tasks-rs/cargo-auto/"><img src="https://img.shields.io/badge/Lines_in_tests-10243-orange.svg" alt=
+            "https://github.com/automation-tasks-rs/cargo-auto/"><img src="https://img.shields.io/badge/Lines_in_tests-549-orange.svg" alt=
             "Lines in tests"></a></p>
             <p>Hashtags: #maintained #ready-for-use #rustlang #automation #workflow<br>
             My projects on GitHub are more like a tutorial than a finished product: <a href="https://github.com/bestia-dev/tutorials_rust_wasm">bestia-dev
@@ -127,7 +127,8 @@ <h3 id="try-it"><a class="doc-anchor" href="#try-it">§</a>Try it</h3>
 cargo auto test
 </code></pre>
             </div>
-            <p>We can also add <code>automation tasks</code> to an existing Rust project. Inside your Rust project directory (the one with Cargo.toml) run:</p>
+            <p>We can also add <code>automation tasks</code> to an existing Rust project. Inside your Rust project directory (the one with
+            <code>Cargo.toml</code>) run:</p>
             <div class="example-wrap">
               <pre class="language-bash"><code>cargo auto new_auto
 cargo auto
@@ -182,7 +183,7 @@ <h3 id="cargo-auto-new_wasm"><a class="doc-anchor" href="#cargo-auto-new_wasm">
             <p>I composed an opinionated template for a simple Rust WASM project for a browser. It is very similar to the new_cli template but for WASM.<br>
             It is easy to run:</p>
             <div class="example-wrap">
-              <pre class="language-bash"><code>cargo auto new_wasm project_name
+              <pre class="language-bash"><code>cargo auto new_wasm project_name github_owner_or_organization web_server_domain server_username
 # then
 cd project_name
 cargo auto build
@@ -192,14 +193,13 @@ <h3 id="cargo-auto-new_wasm"><a class="doc-anchor" href="#cargo-auto-new_wasm">
             <h3 id="cargo-auto-new_pwa_wasm"><a class="doc-anchor" href="#cargo-auto-new_pwa_wasm">§</a>cargo auto new_pwa_wasm</h3>
             <p>I composed an opinionated template for a simple Rust PWA-WASM project for a browser. It is very similar to the new_cli template but for WASM. It
             adds the PWA standard functionality to work as an offline app.<br>
-            The template needs the title, name, long name, and description inside a <code>pwa.json5</code> file and the <code>icon512x512.png</code> file for
-            the icons.<br>
+            The template needs the <code>icon512x512.png</code> file for the icons. You can use the default icon if you don’t have your own. <img src=
+            "https://github.com/automation-tasks-rs/cargo_auto_template_new_pwa_wasm/raw/main/icon512x512.png" alt="icon512x512.png"><br>
             It is easy to run:</p>
             <div class="example-wrap">
-              <pre class="language-bash"><code>cargo auto new_pwa_wasm
-# on first run it will just create the `pwa.json5` and `icon512x512.png` files
-# modify these files with data for your new app and then repeat
-cargo auto new_pwa_wasm
+              <pre class=
+              "language-bash"><code>curl -L https://github.com/automation-tasks-rs/cargo_auto_template_new_pwa_wasm/raw/main/icon512x512.png --output icon512x512.png
+cargo auto new_pwa_wasm project_name github_owner_or_organization web_server_domain server_username
 # then
 cd project_name
 cargo auto build

diff --git a/docs/cargo_auto_local_lib/all.html b/docs/cargo_auto_local_lib/all.html
@@ -33,7 +33,7 @@
     <div class="sidebar-crate">
       <a class="logo-container" href="../cargo_auto_local_lib/index.html"><img src=
       "https://github.com/automation-tasks-rs/cargo-auto/raw/main/images/logo/logo_cargo_auto.svg" alt="logo"></a>
-      <h2><a href="../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.501.55</span></h2>
+      <h2><a href="../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.501.1827</span></h2>
     </div>
     <div class="sidebar-elems">
       <section>
@@ -102,9 +102,6 @@ <h3 id="structs">Structs</h3>
           <li>
             <a href="file_hashes_mod/struct.FileMetaData.html">file_hashes_mod::FileMetaData</a>
           </li>
-          <li>
-            <a href="template_new_pwa_wasm_mod/struct.PwaJson5.html">template_new_pwa_wasm_mod::PwaJson5</a>
-          </li>
         </ul>
         <h3 id="functions">Functions</h3>
         <ul class="all-items">
@@ -180,33 +177,12 @@ <h3 id="functions">Functions</h3>
           <li>
             <a href="template_new_pwa_wasm_mod/fn.copy_to_files.html">template_new_pwa_wasm_mod::copy_to_files</a>
           </li>
-          <li>
-            <a href="template_new_pwa_wasm_mod/fn.decode_png.html">template_new_pwa_wasm_mod::decode_png</a>
-          </li>
-          <li>
-            <a href="template_new_pwa_wasm_mod/fn.encode_to_favicon_ico.html">template_new_pwa_wasm_mod::encode_to_favicon_ico</a>
-          </li>
-          <li>
-            <a href="template_new_pwa_wasm_mod/fn.encode_to_png.html">template_new_pwa_wasm_mod::encode_to_png</a>
-          </li>
-          <li>
-            <a href="template_new_pwa_wasm_mod/fn.favicon_add_entry.html">template_new_pwa_wasm_mod::favicon_add_entry</a>
-          </li>
-          <li>
-            <a href="template_new_pwa_wasm_mod/fn.get_vec_file.html">template_new_pwa_wasm_mod::get_vec_file</a>
-          </li>
           <li>
             <a href="template_new_pwa_wasm_mod/fn.new_pwa_wasm.html">template_new_pwa_wasm_mod::new_pwa_wasm</a>
           </li>
-          <li>
-            <a href="template_new_pwa_wasm_mod/fn.resize_image.html">template_new_pwa_wasm_mod::resize_image</a>
-          </li>
           <li>
             <a href="template_new_wasm_mod/fn.copy_to_files.html">template_new_wasm_mod::copy_to_files</a>
           </li>
-          <li>
-            <a href="template_new_wasm_mod/fn.get_vec_file.html">template_new_wasm_mod::get_vec_file</a>
-          </li>
           <li>
             <a href="template_new_wasm_mod/fn.new_wasm.html">template_new_wasm_mod::new_wasm</a>
           </li>

diff --git a/docs/cargo_auto_local_lib/constant.GREEN.html b/docs/cargo_auto_local_lib/constant.GREEN.html
@@ -34,7 +34,7 @@
     <div class="sidebar-crate">
       <a class="logo-container" href="../cargo_auto_local_lib/index.html"><img src=
       "https://github.com/automation-tasks-rs/cargo-auto/raw/main/images/logo/logo_cargo_auto.svg" alt="logo"></a>
-      <h2><a href="../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.501.55</span></h2>
+      <h2><a href="../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.501.1827</span></h2>
     </div>
     <div class="sidebar-elems"></div>
   </nav>
@@ -59,7 +59,7 @@ <h2><a href="../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span c
         <div class="main-heading">
           <h1>Constant <a href="index.html">cargo_auto_local_lib</a>::<wbr><a class="constant" href="#">GREEN</a><button id="copy-path" title=
           "Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt=
-          "Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/cargo_auto_local_lib/lib.rs.html#299">source</a> · <button id=
+          "Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/cargo_auto_local_lib/lib.rs.html#297">source</a> · <button id=
           "toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span>
         </div>
         <pre class="rust item-decl"><code>pub const GREEN: &<a class="primitive" href=

diff --git a/docs/cargo_auto_local_lib/constant.RED.html b/docs/cargo_auto_local_lib/constant.RED.html
@@ -34,7 +34,7 @@
     <div class="sidebar-crate">
       <a class="logo-container" href="../cargo_auto_local_lib/index.html"><img src=
       "https://github.com/automation-tasks-rs/cargo-auto/raw/main/images/logo/logo_cargo_auto.svg" alt="logo"></a>
-      <h2><a href="../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.501.55</span></h2>
+      <h2><a href="../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.501.1827</span></h2>
     </div>
     <div class="sidebar-elems"></div>
   </nav>
@@ -59,7 +59,7 @@ <h2><a href="../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span c
         <div class="main-heading">
           <h1>Constant <a href="index.html">cargo_auto_local_lib</a>::<wbr><a class="constant" href="#">RED</a><button id="copy-path" title=
           "Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt=
-          "Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/cargo_auto_local_lib/lib.rs.html#295">source</a> · <button id=
+          "Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/cargo_auto_local_lib/lib.rs.html#293">source</a> · <button id=
           "toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span>
         </div>
         <pre class="rust item-decl"><code>pub const RED: &<a class="primitive" href=

diff --git a/docs/cargo_auto_local_lib/constant.RESET.html b/docs/cargo_auto_local_lib/constant.RESET.html
@@ -34,7 +34,7 @@
     <div class="sidebar-crate">
       <a class="logo-container" href="../cargo_auto_local_lib/index.html"><img src=
       "https://github.com/automation-tasks-rs/cargo-auto/raw/main/images/logo/logo_cargo_auto.svg" alt="logo"></a>
-      <h2><a href="../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.501.55</span></h2>
+      <h2><a href="../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.501.1827</span></h2>
     </div>
     <div class="sidebar-elems"></div>
   </nav>
@@ -59,7 +59,7 @@ <h2><a href="../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span c
         <div class="main-heading">
           <h1>Constant <a href="index.html">cargo_auto_local_lib</a>::<wbr><a class="constant" href="#">RESET</a><button id="copy-path" title=
           "Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt=
-          "Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/cargo_auto_local_lib/lib.rs.html#301">source</a> · <button id=
+          "Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/cargo_auto_local_lib/lib.rs.html#299">source</a> · <button id=
           "toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span>
         </div>
         <pre class="rust item-decl"><code>pub const RESET: &<a class="primitive" href=

diff --git a/docs/cargo_auto_local_lib/constant.YELLOW.html b/docs/cargo_auto_local_lib/constant.YELLOW.html
@@ -34,7 +34,7 @@
     <div class="sidebar-crate">
       <a class="logo-container" href="../cargo_auto_local_lib/index.html"><img src=
       "https://github.com/automation-tasks-rs/cargo-auto/raw/main/images/logo/logo_cargo_auto.svg" alt="logo"></a>
-      <h2><a href="../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.501.55</span></h2>
+      <h2><a href="../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.501.1827</span></h2>
     </div>
     <div class="sidebar-elems"></div>
   </nav>
@@ -59,7 +59,7 @@ <h2><a href="../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span c
         <div class="main-heading">
           <h1>Constant <a href="index.html">cargo_auto_local_lib</a>::<wbr><a class="constant" href="#">YELLOW</a><button id="copy-path" title=
           "Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt=
-          "Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/cargo_auto_local_lib/lib.rs.html#297">source</a> · <button id=
+          "Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/cargo_auto_local_lib/lib.rs.html#295">source</a> · <button id=
           "toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span>
         </div>
         <pre class="rust item-decl"><code>pub const YELLOW: &<a class="primitive" href=

diff --git a/docs/cargo_auto_local_lib/file_hashes_mod/fn.are_all_files_equal.html b/docs/cargo_auto_local_lib/file_hashes_mod/fn.are_all_files_equal.html
@@ -34,7 +34,7 @@
     <div class="sidebar-crate">
       <a class="logo-container" href="../../cargo_auto_local_lib/index.html"><img src=
       "https://github.com/automation-tasks-rs/cargo-auto/raw/main/images/logo/logo_cargo_auto.svg" alt="logo"></a>
-      <h2><a href="../../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.501.55</span></h2>
+      <h2><a href="../../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.501.1827</span></h2>
     </div>
     <div class="sidebar-elems">
       <h2><a href="index.html">In cargo_auto_local_lib::file_hashes_mod</a></h2>

diff --git a/docs/cargo_auto_local_lib/file_hashes_mod/fn.is_project_changed.html b/docs/cargo_auto_local_lib/file_hashes_mod/fn.is_project_changed.html
@@ -35,7 +35,7 @@
     <div class="sidebar-crate">
       <a class="logo-container" href="../../cargo_auto_local_lib/index.html"><img src=
       "https://github.com/automation-tasks-rs/cargo-auto/raw/main/images/logo/logo_cargo_auto.svg" alt="logo"></a>
-      <h2><a href="../../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.501.55</span></h2>
+      <h2><a href="../../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.501.1827</span></h2>
     </div>
     <div class="sidebar-elems">
       <h2><a href="index.html">In cargo_auto_local_lib::file_hashes_mod</a></h2>

diff --git a/docs/cargo_auto_local_lib/file_hashes_mod/fn.read_file_metadata.html b/docs/cargo_auto_local_lib/file_hashes_mod/fn.read_file_metadata.html
@@ -34,7 +34,7 @@
     <div class="sidebar-crate">
       <a class="logo-container" href="../../cargo_auto_local_lib/index.html"><img src=
       "https://github.com/automation-tasks-rs/cargo-auto/raw/main/images/logo/logo_cargo_auto.svg" alt="logo"></a>
-      <h2><a href="../../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.501.55</span></h2>
+      <h2><a href="../../cargo_auto_local_lib/index.html">cargo_auto_local_lib</a><span class="version">2024.501.1827</span></h2>
     </div>
     <div class="sidebar-elems">
       <h2><a href="index.html">In cargo_auto_local_lib::file_hashes_mod</a></h2>