From 3b41b95e9d45f3b3c38ec60a2abd81800b1e38ed Mon Sep 17 00:00:00 2001 From: Pascal Thomet Date: Wed, 20 Dec 2023 12:02:11 +0100 Subject: [PATCH] doc --- README.md | 60 +++++++-------------------------------------------- README.src.md | 54 ++++++---------------------------------------- 2 files changed, 15 insertions(+), 99 deletions(-) diff --git a/README.md b/README.md index 90890569..b9276d74 100644 --- a/README.md +++ b/README.md @@ -299,18 +299,14 @@ __Table of contents__ * [Install the requirements (emsdk)](#install-the-requirements-emsdk) * [Build for emscripten](#build-for-emscripten) * [Customizing the emscripten build](#customizing-the-emscripten-build) + * [How to build terminal executables under macOS](#how-to-build-terminal-executables-under-macos) * [Build and deploy instructions for Android](#build-and-deploy-instructions-for-android) - * [Download SDL](#download-sdl) * [Set Android required environment variables](#set-android-required-environment-variables) * [Run cmake in order to create an Android studio project](#run-cmake-in-order-to-create-an-android-studio-project) * [Customize for Android](#customize-for-android) - * [How to build terminal executables under macOS](#how-to-build-terminal-executables-under-macos) - * [Android](#android) * [Real world examples](#real-world-examples) * [ImGui Manual](#imgui-manual) * [Dear ImGui Bundle](#dear-imgui-bundle) - * [CatSight](#catsight) -* [Alternatives](#alternatives) * [Online interactive development platform](#online-interactive-development-platform) -------------------- @@ -459,19 +455,16 @@ into your app source dir, and adapt it to your needs. --- +## How to build terminal executables under macOS + +If you prefer to build regular terminal executables (not app bundles), use the cmake option `-DHELLOIMGUI_MACOS_NO_BUNDLE=ON`. + ## Build and deploy instructions for Android The Android version uses SDL + OpenGLES3. _Note: The Android version is currently not actively maintained._ -### Download SDL - -You need to download SDL manually for Android, like this: - -```bash -./tools/sdl_download.sh -``` ### Set Android required environment variables @@ -540,38 +533,13 @@ You can also install the app via command line, like this: ### Customize for Android +See intructions in [Hello ImGui Template](https://github.com/pthom/hello_imgui_template/). -#### How to build terminal executables under macOS - -If you prefer to build regular terminal executables (not app bundles), use the cmake option `-DHELLOIMGUI_MACOS_NO_BUNDLE=ON`. - - -### Android - -For Android, create a folder named "android" beside the application 'CMakeLists.txt'. There, you can add a custom "res/" folder, containing your icons and application settings inside "res/values/". - -**Example** - -``` -├── android/ # android/ is where you customize the Android App -│ ├── mipmap-source/ -│ │ ├── Readme.md -│ │ └── ic_launcher.png # an icon that helps creating the different sizes -│ └── res/ # anything in the res/ folder will be embedded as a resource -│ ├── mipmap-hdpi/ -│ │ └── ic_launcher.png # icons with different sizes -│ ├── mipmap-.../ -│ └── values/ -│ ├── colors.xml -│ ├── strings.xml # Customize the application icon label here -│ └── styles.xml -``` - - -------- # Real world examples +See [Gallery](https://github.com/pthom/hello_imgui/discussions/82) + ## ImGui Manual [ImGui Manual](https://github.com/pthom/imgui_manual) is an interactive manual for [Dear ImGui](https://github.com/ocornut/imgui), which uses Hello ImGui. @@ -583,20 +551,8 @@ Just click on the image below to open it: ## Dear ImGui Bundle [Dear ImGui Bundle](https://pthom.github.io/imgui_bundle/introduction.html) is a bundle for Dear ImGui, including various powerful libraries from its ecosystem. It is based on HelloImGui. -## CatSight - -[CatSight](https://github.com/codecat/catsight) is a cross-platform process memory inspector. - --- -# Alternatives - -[OpenFrameworks](https://openframeworks.cc/) and [Cinder](https://libcinder.org/) are alternatives in order to quickly start a C++ application under many platforms. - -Being oriented for creative coding, they are much more feature rich, offers some level of native hardware access (camera, accelerometer), but they are also less lightweight than ImGui + HelloImGui. - -[sokol_app](https://github.com/floooh/sokol#sokol_apph) is a minimal cross-platform application-wrapper library. - # Online interactive development platform You can test developping with Hello ImGui in 1 minute, *without even installing anything*, thanks to [Gitpod.io](https://gitpod.io)'s online development platform: [Open Hello ImGui inside Gitpod](https://gitpod.io/#https://github.com/pthom/hello_imgui/) (58 seconds [demo video](https://www.youtube.com/watch?v=1cgemZQ2CMc) on youtube) diff --git a/README.src.md b/README.src.md index 24ba85e0..1c5055a7 100644 --- a/README.src.md +++ b/README.src.md @@ -396,19 +396,16 @@ into your app source dir, and adapt it to your needs. --- +## How to build terminal executables under macOS + +If you prefer to build regular terminal executables (not app bundles), use the cmake option `-DHELLOIMGUI_MACOS_NO_BUNDLE=ON`. + ## Build and deploy instructions for Android The Android version uses SDL + OpenGLES3. _Note: The Android version is currently not actively maintained._ -### Download SDL - -You need to download SDL manually for Android, like this: - -```bash -./tools/sdl_download.sh -``` ### Set Android required environment variables @@ -477,38 +474,13 @@ You can also install the app via command line, like this: ### Customize for Android +See intructions in [Hello ImGui Template](https://github.com/pthom/hello_imgui_template/). -#### How to build terminal executables under macOS - -If you prefer to build regular terminal executables (not app bundles), use the cmake option `-DHELLOIMGUI_MACOS_NO_BUNDLE=ON`. - - -### Android - -For Android, create a folder named "android" beside the application 'CMakeLists.txt'. There, you can add a custom "res/" folder, containing your icons and application settings inside "res/values/". - -**Example** - -``` -├── android/ # android/ is where you customize the Android App -│ ├── mipmap-source/ -│ │ ├── Readme.md -│ │ └── ic_launcher.png # an icon that helps creating the different sizes -│ └── res/ # anything in the res/ folder will be embedded as a resource -│ ├── mipmap-hdpi/ -│ │ └── ic_launcher.png # icons with different sizes -│ ├── mipmap-.../ -│ └── values/ -│ ├── colors.xml -│ ├── strings.xml # Customize the application icon label here -│ └── styles.xml -``` - - -------- # Real world examples +See [Gallery](https://github.com/pthom/hello_imgui/discussions/82) + ## ImGui Manual [ImGui Manual](https://github.com/pthom/imgui_manual) is an interactive manual for [Dear ImGui](https://github.com/ocornut/imgui), which uses Hello ImGui. @@ -520,20 +492,8 @@ Just click on the image below to open it: ## Dear ImGui Bundle [Dear ImGui Bundle](https://pthom.github.io/imgui_bundle/introduction.html) is a bundle for Dear ImGui, including various powerful libraries from its ecosystem. It is based on HelloImGui. -## CatSight - -[CatSight](https://github.com/codecat/catsight) is a cross-platform process memory inspector. - --- -# Alternatives - -[OpenFrameworks](https://openframeworks.cc/) and [Cinder](https://libcinder.org/) are alternatives in order to quickly start a C++ application under many platforms. - -Being oriented for creative coding, they are much more feature rich, offers some level of native hardware access (camera, accelerometer), but they are also less lightweight than ImGui + HelloImGui. - -[sokol_app](https://github.com/floooh/sokol#sokol_apph) is a minimal cross-platform application-wrapper library. - # Online interactive development platform You can test developping with Hello ImGui in 1 minute, *without even installing anything*, thanks to [Gitpod.io](https://gitpod.io)'s online development platform: [Open Hello ImGui inside Gitpod](https://gitpod.io/#https://github.com/pthom/hello_imgui/) (58 seconds [demo video](https://www.youtube.com/watch?v=1cgemZQ2CMc) on youtube)