Skip to content

Commit

Permalink
doc do
Browse files Browse the repository at this point in the history
  • Loading branch information
pthom committed Jan 14, 2024
1 parent 81ff4af commit 10447d7
Show file tree
Hide file tree
Showing 17 changed files with 118 additions and 12 deletions.
7 changes: 7 additions & 0 deletions bindings/imgui_bundle/Readme_pypi.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,13 @@ applications in C++ and Python, under Windows, macOS, and Linux. It is
aimed at application developers, researchers, and beginner developers
who want to quickly get started.

### Support the development of Dear ImGui Bundle

Dear ImGui Bundle is a free and open-source project. If you like it,
please consider supporting its development by [making a
donation](https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA).
Thank you!

## Interactive manual & demo in one click!

Click on the animated demonstration below to launch the fully
Expand Down
80 changes: 80 additions & 0 deletions bindings/imgui_bundle/doc/Readme.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@

:url-demo-images: https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/doc/doc_images

:url-donate: https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA

// :url-demo-images: doc_images/

:_badge-sources: {url-doc-images}/badge_view_sources.png
Expand Down Expand Up @@ -59,6 +61,8 @@ TIP: For a more readable version of this document, click on {btn-doc}

:url-demo-images: https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/doc/doc_images

:url-donate: https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA

// :url-demo-images: doc_images/


Expand Down Expand Up @@ -101,6 +105,8 @@ link:https://github.com/pthom/imgui_bundle/actions/workflows/android.yml[image:{

:url-demo-images: https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/doc/doc_images

:url-donate: https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA

// :url-demo-images: doc_images/

:_badge-sources: {url-doc-images}/badge_view_sources.png
Expand Down Expand Up @@ -147,15 +153,47 @@ Click on the logo for a complete interactive demonstration!

:url-demo-images: https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/doc/doc_images

:url-donate: https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA

// :url-demo-images: doc_images/

=== About Dear ImGui Bundle

:doc_branch: main
:url-bundle: https://github.com/pthom/imgui_bundle/
:url-bundle-doc-tree: https://github.com/pthom/imgui_bundle/tree/{doc_branch}
:url-himgui-master-tree: https://github.com/pthom/hello_imgui/tree/master
:url-bindings-bundle: https://github.com/pthom/imgui_bundle/tree/{doc_branch}/bindings/imgui_bundle
:url-bundle-pages: https://pthom.github.io/imgui_bundle
:url-demo-imgui-bundle: https://traineq.org/ImGuiBundle/emscripten/bin/demo_imgui_bundle.html
:url-imgui-manual: https://pthom.github.io/imgui_manual_online/manual/imgui_manual.html
:url-imgui: https://github.com/ocornut/imgui/
:url-logo: https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/demos_assets/images/logo_imgui_bundle_512.png
:url-demos-cpp: https://github.com/pthom/imgui_bundle/blob/main/bindings/imgui_bundle/demos_cpp
:url-demos-python: https://github.com/pthom/imgui_bundle/blob/main/bindings/imgui_bundle/demos_python

:url-doc-images: https://github.com/pthom/imgui_bundle/raw/main/bindings/imgui_bundle/doc/doc_images

:url-demo-images: https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/doc/doc_images

:url-donate: https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA

// :url-demo-images: doc_images/

// tag::motto[]
https://github.com/pthom/imgui_bundle[Dear ImGui Bundle] is a bundle for https://github.com/ocornut/imgui[Dear ImGui], including various powerful libraries from its ecosystem. It enables to easily create ImGui applications in {cpp} and Python, under Windows, macOS, and Linux. It is aimed at application developers, researchers, and beginner developers who want to quickly get started.
// end::motto[]


===== Support the development of Dear ImGui Bundle

Dear ImGui Bundle is a free and open-source project. If you like it, please consider supporting its development by link:{url-donate}[making a donation]. Thank you!

////
link:{url-donate}[image:https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/doc/doc_images/btn_donate.gif[Donate to support the development of Dear ImGui Bundle]]
////


=== Interactive manual & demo in one click!

:doc_branch: main
Expand All @@ -175,6 +213,8 @@ https://github.com/pthom/imgui_bundle[Dear ImGui Bundle] is a bundle for https:/

:url-demo-images: https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/doc/doc_images

:url-donate: https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA

// :url-demo-images: doc_images/

Click on the animated demonstration below to launch the fully interactive demonstration.
Expand Down Expand Up @@ -204,6 +244,8 @@ TIP: This demonstration is also an interactive manual, similar to the online {ur

:url-demo-images: https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/doc/doc_images

:url-donate: https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA

// :url-demo-images: doc_images/

Dear ImGui Bundle includes the following libraries, which are available in {cpp} _and_ in Python:
Expand Down Expand Up @@ -412,6 +454,8 @@ int main(int , char *[]) {

:url-demo-images: https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/doc/doc_images

:url-donate: https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA

// :url-demo-images: doc_images/

==== Install from pypi
Expand Down Expand Up @@ -465,6 +509,8 @@ TIP: Consider `demo_imgui_bundle` as an always available manual for Dear ImGui B

:url-demo-images: https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/doc/doc_images

:url-donate: https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA

// :url-demo-images: doc_images/

==== Integrate Dear ImGui Bundle in your own project in 5 minutes
Expand Down Expand Up @@ -531,6 +577,8 @@ TIP: Consider `demo_imgui_bundle` as a manual with lots of examples and related

:url-demo-images: https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/doc/doc_images

:url-donate: https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA

// :url-demo-images: doc_images/

First, install Dear ImGui Bundle following the <<install-instructions>>.
Expand All @@ -554,6 +602,8 @@ Then study the examples below.

:url-demo-images: https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/doc/doc_images

:url-donate: https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA

// :url-demo-images: doc_images/

=== Hello, World
Expand Down Expand Up @@ -683,6 +733,8 @@ immapp.run(

:url-demo-images: https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/doc/doc_images

:url-donate: https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA

// :url-demo-images: doc_images/

[[quickstart_about_assets]]
Expand Down Expand Up @@ -806,6 +858,8 @@ You can also specify different settings for macOS and iOS via `Info.macos.plist`

:url-demo-images: https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/doc/doc_images

:url-donate: https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA

// :url-demo-images: doc_images/

=== Demo using assets & add-ons
Expand Down Expand Up @@ -1384,6 +1438,8 @@ if __name__ == "__main__":

:url-demo-images: https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/doc/doc_images

:url-donate: https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA

// :url-demo-images: doc_images/

=== Complex layouts with docking windows
Expand Down Expand Up @@ -3005,6 +3061,8 @@ if __name__ == "__main__":

:url-demo-images: https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/doc/doc_images

:url-donate: https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA

// :url-demo-images: doc_images/

=== Multiplatform C++ applications
Expand Down Expand Up @@ -3036,6 +3094,8 @@ TIP: The principle with Dear ImGui Bundle is the same, just use the dedicated De

:url-demo-images: https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/doc/doc_images

:url-donate: https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA

// :url-demo-images: doc_images/

=== Custom 3D Background
Expand Down Expand Up @@ -3074,6 +3134,8 @@ Its source code is heavily documented and should be self-explanatory.

:url-demo-images: https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/doc/doc_images

:url-donate: https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA

// :url-demo-images: doc_images/

[[quickstart_testengine]]
Expand Down Expand Up @@ -3546,6 +3608,8 @@ if __name__ == "__main__":

:url-demo-images: https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/doc/doc_images

:url-donate: https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA

// :url-demo-images: doc_images/

=== Display & analyze images with ImmVision
Expand Down Expand Up @@ -3923,6 +3987,8 @@ if __name__ == "__main__":

:url-demo-images: https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/doc/doc_images

:url-donate: https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA

// :url-demo-images: doc_images/

=== Widgets
Expand Down Expand Up @@ -5128,6 +5194,8 @@ image::{url-demo-images}/demo_gizmo.jpg[width="400"]

:url-demo-images: https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/doc/doc_images

:url-donate: https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA

// :url-demo-images: doc_images/

Dear ImGui is an implementation of the Immediate Gui paradigm.
Expand Down Expand Up @@ -5217,6 +5285,8 @@ image::{url-doc-images}/immediate_gui_example.png[]

:url-demo-images: https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/doc/doc_images

:url-donate: https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA

// :url-demo-images: doc_images/

Dear ImGui Bundle includes https://github.com/pthom/hello_imgui[Hello ImGui], which is itself based on ImGui. "Hello ImGui" can be compared to a starter pack that enables to easily write cross-platform Gui apps for Windows, macOS, Linux, iOS, and https://en.wikipedia.org/wiki/Emscripten[emscripten].
Expand Down Expand Up @@ -5292,6 +5362,8 @@ Links:

:url-demo-images: https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/doc/doc_images

:url-donate: https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA

// :url-demo-images: doc_images/


Expand Down Expand Up @@ -5410,6 +5482,8 @@ if __name__ == "__main__":

:url-demo-images: https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/doc/doc_images

:url-donate: https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA

// :url-demo-images: doc_images/

=== Application Settings
Expand Down Expand Up @@ -5827,6 +5901,8 @@ if __name__ == "__main__":

:url-demo-images: https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/doc/doc_images

:url-donate: https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA

// :url-demo-images: doc_images/
:notebook-example-image: {url-doc-images}/immapp_notebook_example.jpg

Expand Down Expand Up @@ -6091,6 +6167,8 @@ void DemoInputTextUpperCase_StdString()

:url-demo-images: https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/doc/doc_images

:url-donate: https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA

// :url-demo-images: doc_images/

In C++, you would write:
Expand Down Expand Up @@ -6178,6 +6256,8 @@ Example: https://github.com/pthom/hello_imgui/issues/33[this issue on macOS] was

:url-demo-images: https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/doc/doc_images

:url-donate: https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA

// :url-demo-images: doc_images/

:url-bindings-python: https://github.com/pthom/imgui_bundle/tree/main/bindings/imgui_bundle
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 2 additions & 0 deletions bindings/imgui_bundle/doc/doc_parts/_utils.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -15,4 +15,6 @@

:url-demo-images: https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/doc/doc_images

:url-donate: https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA

// :url-demo-images: doc_images/
11 changes: 11 additions & 0 deletions bindings/imgui_bundle/doc/doc_parts/intro_about.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
=== About Dear ImGui Bundle

include::_utils.adoc[]

// tag::motto[]
https://github.com/pthom/imgui_bundle[Dear ImGui Bundle] is a bundle for https://github.com/ocornut/imgui[Dear ImGui], including various powerful libraries from its ecosystem. It enables to easily create ImGui applications in {cpp} and Python, under Windows, macOS, and Linux. It is aimed at application developers, researchers, and beginner developers who want to quickly get started.
// end::motto[]


===== Support the development of Dear ImGui Bundle

Dear ImGui Bundle is a free and open-source project. If you like it, please consider supporting its development by link:{url-donate}[making a donation]. Thank you!

////
link:{url-donate}[image:https://raw.githubusercontent.com/pthom/imgui_bundle/main/bindings/imgui_bundle/doc/doc_images/btn_donate.gif[Donate to support the development of Dear ImGui Bundle]]
////
2 changes: 1 addition & 1 deletion docs/devel_docs.html
Original file line number Diff line number Diff line change
Expand Up @@ -486,7 +486,7 @@ <h2 id="devel_docs">Developer docs</h2>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-01-14 10:11:05 +0100
Last updated 2024-01-14 18:31:19 +0100
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/faq.html
Original file line number Diff line number Diff line change
Expand Up @@ -815,7 +815,7 @@ <h4 id="_windows_linux_adapting_windows_and_font_size_when_application_is_moved_
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-01-14 10:11:05 +0100
Last updated 2024-01-14 18:31:19 +0100
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/folders.html
Original file line number Diff line number Diff line change
Expand Up @@ -655,7 +655,7 @@ <h2 id="folders">Repository folders structure</h2>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-01-14 10:11:05 +0100
Last updated 2024-01-14 18:31:19 +0100
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -541,7 +541,7 @@ <h1>Dear ImGui Bundle documentation</h1>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-01-14 10:11:05 +0100
Last updated 2024-01-14 18:31:19 +0100
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/install-instructions.html
Original file line number Diff line number Diff line change
Expand Up @@ -700,7 +700,7 @@ <h4 id="_run_the_c_demo">Run the C&#43;&#43; demo</h4>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-01-14 10:11:05 +0100
Last updated 2024-01-14 18:31:19 +0100
</div>
</div>
</body>
Expand Down
8 changes: 7 additions & 1 deletion docs/introduction.html
Original file line number Diff line number Diff line change
Expand Up @@ -561,6 +561,12 @@ <h3 id="_about_dear_imgui_bundle">About Dear ImGui Bundle</h3>
<div class="paragraph">
<p><a href="https://github.com/pthom/imgui_bundle">Dear ImGui Bundle</a> is a bundle for <a href="https://github.com/ocornut/imgui">Dear ImGui</a>, including various powerful libraries from its ecosystem. It enables to easily create ImGui applications in C&#43;&#43; and Python, under Windows, macOS, and Linux. It is aimed at application developers, researchers, and beginner developers who want to quickly get started.</p>
</div>
<div class="sect4">
<h5 id="_support_the_development_of_dear_imgui_bundle">Support the development of Dear ImGui Bundle</h5>
<div class="paragraph">
<p>Dear ImGui Bundle is a free and open-source project. If you like it, please consider supporting its development by <a href="https://www.paypal.com/donate/?hosted_button_id=SHJ68RVDKURZA">making a donation</a>. Thank you!</p>
</div>
</div>
</div>
<div class="sect2">
<h3 id="_interactive_manual_demo_in_one_click">Interactive manual &amp; demo in one click!</h3>
Expand Down Expand Up @@ -818,7 +824,7 @@ <h3 id="_easily_port_your_code_between_python_and_c">Easily port your code betwe
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-01-14 10:11:05 +0100
Last updated 2024-01-14 18:31:19 +0100
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/manual.html
Original file line number Diff line number Diff line change
Expand Up @@ -1416,7 +1416,7 @@ <h4 id="_api_2">API:</h4>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-01-14 10:11:05 +0100
Last updated 2024-01-14 18:31:19 +0100
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/porting.html
Original file line number Diff line number Diff line change
Expand Up @@ -826,7 +826,7 @@ <h3 id="_debug_native_c_in_python_scripts">Debug native C&#43;&#43; in python sc
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-01-14 10:11:05 +0100
Last updated 2024-01-14 18:31:19 +0100
</div>
</div>
</body>
Expand Down
2 changes: 1 addition & 1 deletion docs/python_specific.html
Original file line number Diff line number Diff line change
Expand Up @@ -507,7 +507,7 @@ <h3 id="_pure_python_backends">Pure python backends</h3>
</div>
<div id="footer">
<div id="footer-text">
Last updated 2024-01-14 10:11:05 +0100
Last updated 2024-01-14 18:31:19 +0100
</div>
</div>
</body>
Expand Down
Loading

0 comments on commit 10447d7

Please sign in to comment.