Skip to content

Add syntax highlighting to block codes in main README #434

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Neblinus wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add syntax highlighting to block codes in main README #434

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 12 additions & 11 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ adapt it to your stack.
JDK 17+ is required to run the build (Gradle's toolchain pins it). Published artifacts target Java 8 bytecode, so
consuming them as a dependency only needs JDK 8+ at runtime.

```
```bash
git clone --recurse-submodules https://github.com/SpaiR/imgui-java.git
cd imgui-java
./gradlew :example:run
Expand Down Expand Up @@ -75,7 +75,7 @@ On Apple Silicon nothing extra is needed: the published macOS native is a univer

Use SDL3 by switching backend in `configure(...)`:

```
```java
@Override
protected void configure(final Configuration config) {
config.setBackend(Backend.SDL);
Expand All @@ -84,7 +84,7 @@ protected void configure(final Configuration config) {

For a ready smoke-test entry point, run `MainSdl`:

```
```bash
./gradlew :example:run -PmainClass=MainSdl
```

Expand All @@ -105,7 +105,8 @@ That means that if you are seeking for a bit more low-level control - you can ga
### Example

A very simple application may look like this:
```

```java
import imgui.ImGui;
import imgui.app.Application;
import imgui.app.Configuration;
Expand Down Expand Up @@ -136,7 +137,7 @@ Read `imgui.app.Application` [javadoc](https://javadoc.io/doc/io.github.spair/im
<details>
<summary><b>Gradle</b></summary>

```
```gradle
repositories {
mavenCentral()
}
Expand All @@ -150,7 +151,7 @@ dependencies {
<details>
<summary><b>Maven</b></summary>

```
```xml
<dependencies>
<dependency>
<groupId>io.github.spair</groupId>
Expand Down Expand Up @@ -202,7 +203,7 @@ Take a note, that you also need to add dependencies to [LWJGL](https://www.lwjgl
<details>
<summary><b>Gradle</b></summary>

```
```gradle
repositories {
mavenCentral()
}
Expand Down Expand Up @@ -231,7 +232,7 @@ dependencies {
<details>
<summary><b>Maven</b></summary>

```
```xml
<properties>
<lwjgl.version>3.4.1</lwjgl.version>
<imgui.java.version>${version}</imgui.java.version>
Expand Down Expand Up @@ -396,7 +397,7 @@ The Gradle toolchain pins **JDK 17** for the build regardless of your system JDK
This is the path CI uses. It vendors FreeType, runs `generateLibs`, and lays the resulting binary under
`/tmp/imgui/dst/`:

```
```bash
buildSrc/scripts/build.sh <windows|linux|macos>
```

Expand All @@ -405,7 +406,7 @@ via `lipo`.

To use the freshly-built binary with the example:

```
```bash
cp /tmp/imgui/dst/libimgui-java64.<so|dylib|dll> bin/
./gradlew :example:run -PlibPath=$PWD/bin
```
Expand Down Expand Up @@ -455,7 +456,7 @@ The Java side of the binding is **codegen-driven**. Annotated stubs live under `
generator in `buildSrc/` expands them into `imgui-binding/src/generated/java/` (both trees are committed). Never
hand-edit `src/generated/`: it is regenerated and your changes will be lost. The workflow is always:

```
```bash
# edit imgui-binding/src/main/java/...
./gradlew :imgui-binding:generateApi
# commit both src/main/java and src/generated/java in one commit
Expand Down