Skip to content

Commit

Permalink
Update docs links and example instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
JamesWrigley committed Dec 25, 2024
1 parent d6e0656 commit bb6dd7c
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 6 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# ImGuiTestEngine.jl
[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://JuliaImGui.github.io/ImGuiTestEngine.jl/stable)
[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://JuliaImGui.github.io/ImGuiTestEngine.jl/dev)
[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliaimgui.github.io/ImGuiDocs.jl/imguitestengine/stable)
[![](https://img.shields.io/badge/docs-dev-blue.svg)](https://juliaimgui.github.io/ImGuiDocs.jl/imguitestengine/dev)

This package provides Julia bindings for the [Dear ImGui test
engine](https://github.com/ocornut/imgui_test_engine), a testing library for
[Dear ImGui](https://github.com/ocornut/imgui) (available in Julia from
[CImGui.jl](https://github.com/Gnimuc/CImGui.jl)). See the docs for more
[CImGui.jl](https://juliaimgui.github.io/ImGuiDocs.jl/cimgui)). See the docs for more
information.
5 changes: 2 additions & 3 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ This package provides Julia bindings for the
[Dear ImGui test engine](https://github.com/ocornut/imgui_test_engine), a
testing and automation library for [Dear
ImGui](https://github.com/ocornut/imgui). It's designed to be used with programs
written with [CImGui.jl](https://github.com/Gnimuc/CImGui.jl).
written with [CImGui.jl](https://juliaimgui.github.io/ImGuiDocs.jl/cimgui).

Known issues:
- Some parts of the integration with [`@imcheck`](@ref) and the stdlib `Test`
Expand All @@ -26,7 +26,7 @@ import CImGui as ig
# Set up the backend for CImGui
import GLFW
import ModernGL
ig.backend = :GlfwOpenGL
ig.set_backend(:GlfwOpenGL3)

# Create the ImGui context and test engine instance
ctx = ig.CreateContext()
Expand Down Expand Up @@ -59,6 +59,5 @@ end

# Note that we don't need to explictly destroy `ctx` because `ig.render()` will
# do it for us.
te.Stop(engine)
te.DestroyContext(engine)
```

0 comments on commit bb6dd7c

Please sign in to comment.