Skip to content

Commit

Permalink
Update docs / 2024-01-14 / 21:38:37
Browse files Browse the repository at this point in the history
  • Loading branch information
@pthom
pthom committed Jan 14, 2024
1 parent 7f38e0f commit 029fc10
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 21 deletions.
27 changes: 17 additions & 10 deletions docs/book/00_00_intro.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -397,6 +397,7 @@ <h2> Contents </h2>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#support-the-project">Support the project</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#credits">Credits</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#license">License</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#contribute">Contribute</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#demos-real-world-apps">Demos &amp; real world apps</a><ul class="nav section-nav flex-column">
Expand All @@ -422,21 +423,21 @@ <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 that enables quickly write multiplatform apps with the simplicity of a “Hello World” app. Although being extremely easy to use, it can be used to create complex and customizable applications. It is based on <a class="reference external" href="https://github.com/ocornut/imgui">Dear ImGui</a>.</p>
<p>Hello ImGui is a powerful library designed to make multiplatform app development as simple as crafting a “Hello World” program. Built on <a class="reference external" href="https://github.com/ocornut/imgui">Dear ImGui</a>, it offers an unparalleled blend of simplicity for beginners and flexibility for advanced users. Whether you’re creating prototypes or complex applications, Hello ImGui streamlines the process across various platforms.</p>
<section id="features">
<h2>Features<a class="headerlink" href="#features" title="Permalink to this heading">#</a></h2>
<p><strong>Multiplatform utilities</strong></p>
<ul class="simple">
<li><p>Truly multiplatform: Linux, Windows, macOS, iOS, Android, emscripten (with 4 lines of CMake code)</p></li>
<li><p>Easily embed assets on all platforms (no code required)</p></li>
<li><p>Customize app settings (icon and app name for mobile platforms, etc.- no code required)</p></li>
<li><p>Customize application icon on all platforms (including mobile and macOS - no code required)</p></li>
<li><p>Seamlessly multiplatform: supports Linux, Windows, macOS, iOS, Android, and Emscripten with minimal setup (1 line of CMake code)</p></li>
<li><p>Asset embedding across all platforms (no code required)</p></li>
<li><p>Effortless app customization, including app icons and names for mobile platforms (no code required)</p></li>
<li><p>Universal application icon customization, extending to mobile and macOS (no code required)</p></li>
</ul>
<p><strong>Dear ImGui Tweaks</strong></p>
<ul class="simple">
<li><p>Power Save mode: reduce FPS when idling</p></li>
<li><p>High DPI support: scale UI according to DPI, whatever the platform</p></li>
<li><p>Advanced layout handling: dockable windows, multiple layouts</p></li>
<li><p>Power Save mode: optimize performance by reducing FPS when idle</p></li>
<li><p>High DPI support: automatically scales UI to match screen DPI on any platform.</p></li>
<li><p>Enhanced layout handling: dockable windows and multiple layouts for complex UIs</p></li>
<li><p>Window geometry utilities: autosize application window, restore app window position</p></li>
<li><p>Theme tweaking: extensive list of additional themes</p></li>
<li><p>Support for movable and resizable borderless windows</p></li>
Expand All @@ -455,20 +456,25 @@ <h2>Features<a class="headerlink" href="#features" title="Permalink to this head
<h2>About<a class="headerlink" href="#about" title="Permalink to this heading">#</a></h2>
<section id="support-the-project">
<h3>Support the project<a class="headerlink" href="#support-the-project" title="Permalink to this heading">#</a></h3>
<p>Hello ImGui is a free and open source project, and its development and maintenance require considerable efforts. If you like it, please consider supporting its development by <a class="reference external" href="https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA">making a donation</a>. Thank you!</p>
<p>Hello ImGui is a free and open source project, and its development and maintenance require considerable efforts.</p>
<p>If you find it valuable for your work – especially in a commercial enterprise or a research setting – please consider supporting its development by <a class="reference external" href="https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA">making a donation</a>. Thank you!</p>
<!--
[![](https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/doc/doc_images/btn_donate.gif)](https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA)
-->
</section>
<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> (copyright © 2024, all rights reserved), <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 <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>
</section>
<section id="license">
<h3>License<a class="headerlink" href="#license" title="Permalink to this heading">#</a></h3>
<p>Hello ImGui is licensed under the MIT License, see <a class="reference external" href="https://github.com/pthom/hello_imgui/blob/master/LICENSE">LICENSE</a></p>
</section>
<section id="contribute">
<h3>Contribute<a class="headerlink" href="#contribute" title="Permalink to this heading">#</a></h3>
<p>Quality contributions are welcome!</p>
</section>
</section>
<hr class="docutils" />
<section id="demos-real-world-apps">
Expand Down Expand Up @@ -578,6 +584,7 @@ <h3>Theme tweaking<a class="headerlink" href="#theme-tweaking" title="Permalink
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#support-the-project">Support the project</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#credits">Credits</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#license">License</a></li>
<li class="toc-h3 nav-item toc-entry"><a class="reference internal nav-link" href="#contribute">Contribute</a></li>
</ul>
</li>
<li class="toc-h2 nav-item toc-entry"><a class="reference internal nav-link" href="#demos-real-world-apps">Demos &amp; real world apps</a><ul class="nav section-nav flex-column">
Expand Down
28 changes: 18 additions & 10 deletions docs/book/_sources/00_00_intro.md
View file
Original file line number Diff line number Diff line change
@@ -1,19 +1,20 @@
# Hello ImGui

Hello ImGui is a library that enables quickly write multiplatform apps with the simplicity of a "Hello World" app. Although being extremely easy to use, it can be used to create complex and customizable applications. It is based on [Dear ImGui](https://github.com/ocornut/imgui).

Hello ImGui is a powerful library designed to make multiplatform app development as simple as crafting a "Hello World" program. Built on [Dear ImGui](https://github.com/ocornut/imgui), it offers an unparalleled blend of simplicity for beginners and flexibility for advanced users. Whether you're creating prototypes or complex applications, Hello ImGui streamlines the process across various platforms.

## Features

**Multiplatform utilities**
* Truly multiplatform: Linux, Windows, macOS, iOS, Android, emscripten (with 4 lines of CMake code)
* Easily embed assets on all platforms (no code required)
* Customize app settings (icon and app name for mobile platforms, etc.- no code required)
* Customize application icon on all platforms (including mobile and macOS - no code required)
* Seamlessly multiplatform: supports Linux, Windows, macOS, iOS, Android, and Emscripten with minimal setup (1 line of CMake code)
* Asset embedding across all platforms (no code required)
* Effortless app customization, including app icons and names for mobile platforms (no code required)
* Universal application icon customization, extending to mobile and macOS (no code required)

**Dear ImGui Tweaks**
* Power Save mode: reduce FPS when idling
* High DPI support: scale UI according to DPI, whatever the platform
* Advanced layout handling: dockable windows, multiple layouts
* Power Save mode: optimize performance by reducing FPS when idle
* High DPI support: automatically scales UI to match screen DPI on any platform.
* Enhanced layout handling: dockable windows and multiple layouts for complex UIs
* Window geometry utilities: autosize application window, restore app window position
* Theme tweaking: extensive list of additional themes
* Support for movable and resizable borderless windows
Expand All @@ -30,21 +31,28 @@ Hello ImGui is a library that enables quickly write multiplatform apps with the
## About

### Support the project
Hello ImGui is a free and open source project, and its development and maintenance require considerable efforts. If you like it, please consider supporting its development by [making a donation](https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA). Thank you!
Hello ImGui is a free and open source project, and its development and maintenance require considerable efforts.

If you find it valuable for your work – especially in a commercial enterprise or a research setting – please consider supporting its development by [making a donation](https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA). Thank you!

<!--
[![](https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/doc/doc_images/btn_donate.gif)](https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA)
-->

### Credits

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) (copyright © 2024, all rights reserved), [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](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

Hello ImGui is licensed under the MIT License, see [LICENSE](https://github.com/pthom/hello_imgui/blob/master/LICENSE)

### Contribute

Quality contributions are welcome!

---

## Demos & real world apps
Expand Down
Loading

0 comments on commit 029fc10

Please sign in to comment.