Update docs / 2024-01-15 / 23:01:50

pthom · Jan 15, 2024 · 2563952 · 2563952
1 parent 86923ad
commit 2563952
Show file tree

Hide file tree

Showing 9 changed files with 33 additions and 6 deletions.
diff --git a/docs/book/_sources/intro.md b/docs/book/_sources/intro.md
@@ -3,7 +3,7 @@
 
 Hello ImGui is a library designed to make multiplatform app development as simple as writing a "Hello World" program, built on top of [Dear ImGui](https://github.com/ocornut/imgui).
 
-Its simplicity makes it ideal for application prototypes, and its flexibility makes it also suited for complex applications; allowing you to focus on the creative aspects of your projects.
+Its flexibility makes it suited for complex applications, as well as for simple prototypes; allowing you to focus on the creative aspects of your projects.
 
 ## Features
 
@@ -113,7 +113,7 @@ How to use the theme tweaking utilities provided by Hello ImGui
 
 Hello ImGui is based on [Dear ImGui](https://github.com/ocornut/imgui) (MIT License), by Omar Cornut. Portions use [ImGui Test Engine](https://github.com/ocornut/imgui_test_engine), which is governed by a [specific license](https://github.com/ocornut/imgui_test_engine/blob/main/imgui_test_engine/LICENSE.txt)
 
-Portions of this software use the [FreeType Project](www.freetype.org), [lunasvg](https://github.com/sammycage/lunasvg) (MIT License), [GLFW](https://www.glfw.org/) (zlib/libpng license), [SDL](https://www.libsdl.org/) (zlib license).
+Portions of this software use the [FreeType Project](https://www.freetype.org), [lunasvg](https://github.com/sammycage/lunasvg) (MIT License), [GLFW](https://www.glfw.org/) (zlib/libpng license), [SDL](https://www.libsdl.org/) (zlib license).
 
 ### License
 

diff --git a/docs/book/build.html b/docs/book/build.html
@@ -66,6 +66,7 @@
     <script>DOCUMENTATION_OPTIONS.pagename = 'build';</script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
+    <link rel="prev" title="Application parameters" href="doc_params.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
   </head>
@@ -175,7 +176,7 @@
                 </a>
             </li>
         </ul>
-        <ul class="nav bd-sidenav">
+        <ul class="current nav bd-sidenav">
 <li class="toctree-l1"><a class="reference internal" href="get_started.html">Get started</a></li>
 <li class="toctree-l1"><a class="reference internal" href="doc_api.html">API</a></li>
 
@@ -195,6 +196,7 @@
 
 
 
+<li class="toctree-l1 current active"><a class="current reference internal" href="#">Build instructions</a></li>
 </ul>
 
     </div>
@@ -615,6 +617,15 @@ <h3>Android instructions<a class="headerlink" href="#android-instructions" title
                 <footer class="prev-next-footer">
 
 <div class="prev-next-area">
+    <a class="left-prev"
+       href="doc_params.html"
+       title="previous page">
+      <i class="fa-solid fa-angle-left"></i>
+      <div class="prev-next-info">
+        <p class="prev-next-subtitle">previous</p>
+        <p class="prev-next-title">Application parameters</p>
+      </div>
+    </a>
 </div>
                 </footer>
 

diff --git a/docs/book/doc_api.html b/docs/book/doc_api.html
@@ -197,6 +197,7 @@
 
 
 
+<li class="toctree-l1"><a class="reference internal" href="build.html">Build instructions</a></li>
 </ul>
 
     </div>

diff --git a/docs/book/doc_params.html b/docs/book/doc_params.html
@@ -66,6 +66,7 @@
     <script>DOCUMENTATION_OPTIONS.pagename = 'doc_params';</script>
     <link rel="index" title="Index" href="genindex.html" />
     <link rel="search" title="Search" href="search.html" />
+    <link rel="next" title="Build instructions" href="build.html" />
     <link rel="prev" title="API" href="doc_api.html" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
@@ -196,6 +197,7 @@
 
 
 
+<li class="toctree-l1"><a class="reference internal" href="build.html">Build instructions</a></li>
 </ul>
 
     </div>
@@ -1646,6 +1648,15 @@ <h2>Renderer Backend Options<a class="headerlink" href="#renderer-backend-option
         <p class="prev-next-title">API</p>
       </div>
     </a>
+    <a class="right-next"
+       href="build.html"
+       title="next page">
+      <div class="prev-next-info">
+        <p class="prev-next-subtitle">next</p>
+        <p class="prev-next-title">Build instructions</p>
+      </div>
+      <i class="fa-solid fa-angle-right"></i>
+    </a>
 </div>
                 </footer>
 

diff --git a/docs/book/genindex.html b/docs/book/genindex.html
@@ -194,6 +194,7 @@
 
 
 
+<li class="toctree-l1"><a class="reference internal" href="build.html">Build instructions</a></li>
 </ul>
 
     </div>

diff --git a/docs/book/get_started.html b/docs/book/get_started.html
@@ -197,6 +197,7 @@
 
 
 
+<li class="toctree-l1"><a class="reference internal" href="build.html">Build instructions</a></li>
 </ul>
 
     </div>

diff --git a/docs/book/intro.html b/docs/book/intro.html
@@ -196,6 +196,7 @@
 
 
 
+<li class="toctree-l1"><a class="reference internal" href="build.html">Build instructions</a></li>
 </ul>
 
     </div>
@@ -424,7 +425,7 @@ <h2> Contents </h2>
   <section class="tex2jax_ignore mathjax_ignore" id="hello-imgui">
 <h1>Hello ImGui<a class="headerlink" href="#hello-imgui" title="Permalink to this heading">#</a></h1>
 <p>Hello ImGui is a library designed to make multiplatform app development as simple as writing a “Hello World” program, built on top of <a class="reference external" href="https://github.com/ocornut/imgui">Dear ImGui</a>.</p>
-<p>Its simplicity makes it ideal for application prototypes, and its flexibility makes it also suited for complex applications; allowing you to focus on the creative aspects of your projects.</p>
+<p>Its flexibility makes it suited for complex applications, as well as for simple prototypes; allowing you to focus on the creative aspects of your projects.</p>
 <section id="features">
 <h2>Features<a class="headerlink" href="#features" title="Permalink to this heading">#</a></h2>
 <p><strong>Multiplatform utilities</strong></p>
@@ -519,7 +520,7 @@ <h2>About<a class="headerlink" href="#about" title="Permalink to this heading">#
 <section id="credits">
 <h3>Credits<a class="headerlink" href="#credits" title="Permalink to this heading">#</a></h3>
 <p>Hello ImGui is based on <a class="reference external" href="https://github.com/ocornut/imgui">Dear ImGui</a> (MIT License), by Omar Cornut. Portions use <a class="reference external" href="https://github.com/ocornut/imgui_test_engine">ImGui Test Engine</a>, which is governed by a <a class="reference external" href="https://github.com/ocornut/imgui_test_engine/blob/main/imgui_test_engine/LICENSE.txt">specific license</a></p>
-<p>Portions of this software use the <span class="xref myst">FreeType Project</span>, <a class="reference external" href="https://github.com/sammycage/lunasvg">lunasvg</a> (MIT License), <a class="reference external" href="https://www.glfw.org/">GLFW</a> (zlib/libpng license), <a class="reference external" href="https://www.libsdl.org/">SDL</a> (zlib license).</p>
+<p>Portions of this software use the <a class="reference external" href="https://www.freetype.org">FreeType Project</a>, <a class="reference external" href="https://github.com/sammycage/lunasvg">lunasvg</a> (MIT License), <a class="reference external" href="https://www.glfw.org/">GLFW</a> (zlib/libpng license), <a class="reference external" href="https://www.libsdl.org/">SDL</a> (zlib license).</p>
 </section>
 <section id="license">
 <h3>License<a class="headerlink" href="#license" title="Permalink to this heading">#</a></h3>

diff --git a/docs/book/search.html b/docs/book/search.html
@@ -196,6 +196,7 @@
 
 
 
+<li class="toctree-l1"><a class="reference internal" href="build.html">Build instructions</a></li>
 </ul>
 
     </div>

diff --git a/docs/book/searchindex.js b/docs/book/searchindex.js