Skip to content

Commit

Permalink
doc
Browse files Browse the repository at this point in the history
  • Loading branch information
pthom committed Dec 20, 2023
1 parent d15d343 commit 3b41b95
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 99 deletions.
60 changes: 8 additions & 52 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
--------------------
Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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.
Expand All @@ -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)
54 changes: 7 additions & 47 deletions README.src.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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.
Expand All @@ -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)

0 comments on commit 3b41b95

Please sign in to comment.