Skip to content

Commit 476fbf8

Browse files
committed
Documentation: Update SCExample documentation
1 parent 5be2d02 commit 476fbf8

File tree

2 files changed

+19
-14
lines changed

2 files changed

+19
-14
lines changed

Documentation/Pages/Examples.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,21 +7,26 @@
77

88
## SCExample
99

10-
| Property | Value |
11-
|:--------------|:--------------------------------------------------------------------------------------------------------------------------|
12-
| Location | `Examples/SCExample` |
13-
| Description | Simple immediate mode gui application using sokol and dear imgui libraries pausing in absence of inputs to save CPU time |
14-
| Purpose | Use `SC::Build` to generate projects for macOS, windows and linux . |
15-
| Run (Posix) | `./SC.sh build run SCExample` |
16-
| Run (Windows) | `SC.bat build run SCExample` |
17-
| Debug (VSCode)| Select correct `SCExample $ARCH ($PLATFORM)` for your system and press `Start Debugging` (F5) |
18-
| Debug (XCode) | Open `_Build/_Projects/XCode/SCExample.xcodeproj` and choose `Product` --> `Run` |
19-
| Debug (VS2022)| Open `_Build/_Projects/VisualStudio2022/SCExample.sln` and start Debugging (F5) |
20-
21-
https://github.com/Pagghiu/SaneCppLibraries/assets/5406873/946684f2-b0c5-436b-b472-c34f07021d03
10+
| Property | Value |
11+
|:--------------|:----------------------------------------------------------------------------------------------------------------------------------|
12+
| Location | `Examples/SCExample` |
13+
| Description | Simple immediate mode gui application using sokol and dear imgui libraries pausing in absence of inputs and I/O to save CPU time |
14+
| Purpose | Use [SC::Build](@ref library_build) to build on macOS, windows and linux and [SC::Async](@ref library_async) as I/O event Loop |
15+
| Prerequisites | Linux - Fedora: `sudo dnf install mesa-libGL-devel mesa-libEGL-devel libX11-devel libXi-devel libXcursor-devel` |
16+
| | Linux - Ubuntu: `sudo apt-get install libgles2-mesa-dev libx11-dev libxi-dev libxcursor-dev` |
17+
| | Windows: None |
18+
| | macOS: None |
19+
| Dependencies | `sokol` and `dear-imgui` are automatically downloaded during `./SC.sh build configure` or `SC.bat build configure` |
20+
| Run (Posix) | `./SC.sh build run SCExample` |
21+
| Run (Windows) | `SC.bat build run SCExample` |
22+
| Debug (VSCode)| Select correct `SCExample $ARCH ($PLATFORM)` for your system and press `Start Debugging` (F5) |
23+
| Debug (XCode) | Open `_Build/_Projects/XCode/SCExample.xcodeproj` and choose `Product` --> `Run` |
24+
| Debug (VS2022)| Open `_Build/_Projects/VisualStudio2022/SCExample.sln` and start Debugging (F5) |
25+
26+
https://github.com/Pagghiu/SaneCppLibraries/assets/5406873/f12f3cd5-0c25-47ab-a22d-e37ac138b0db
2227

2328
\htmlonly
24-
<iframe width="700" height="400" src="https://github.com/Pagghiu/SaneCppLibraries/assets/5406873/946684f2-b0c5-436b-b472-c34f07021d03" frameborder="0" allowfullscreen>
29+
<iframe width="700" height="400" src="https://github.com/Pagghiu/SaneCppLibraries/assets/5406873/f12f3cd5-0c25-47ab-a22d-e37ac138b0db" frameborder="0" allowfullscreen>
2530
\endhtmlonly
2631
2732
# Where can I find more examples?

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -90,7 +90,7 @@ Shortly:
9090

9191
Check the [Examples](https://pagghiu.github.io/SaneCppLibraries/page_examples.html) page.
9292

93-
https://github.com/Pagghiu/SaneCppLibraries/assets/5406873/946684f2-b0c5-436b-b472-c34f07021d03
93+
https://github.com/Pagghiu/SaneCppLibraries/assets/5406873/f12f3cd5-0c25-47ab-a22d-e37ac138b0db
9494

9595
# Tests
9696

0 commit comments

Comments
 (0)