Skip to content

Commit

Permalink
Documentation: Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Pagghiu committed Jul 26, 2024
1 parent 415dc32 commit 4f797e4
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
5 changes: 3 additions & 2 deletions Documentation/Pages/Examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
| Description | Simple immediate mode gui application using sokol and dear imgui libraries pausing in absence of inputs and I/O to save CPU time |
| Purposes | Use [SC::Build](@ref library_build) to build on macOS, windows and linux and [SC::Async](@ref library_async) as I/O event Loop |
| | Use [Plugin](@ref library_plugin) and [FileSystemWatcher](@ref library_file_system_watcher) libraries implementing hot-reload |
| | Use [Reflection](@ref library_reflection) and [Serialization](@ref library_serialization_binary) to persist application state |
| Prerequisites | Linux - Fedora: `sudo dnf install mesa-libGL-devel mesa-libEGL-devel libX11-devel libXi-devel libXcursor-devel` |
| | Linux - Ubuntu: `sudo apt-get install libgles2-mesa-dev libx11-dev libxi-dev libxcursor-dev` |
| | Windows: None |
Expand All @@ -24,11 +25,11 @@
| Debug (XCode) | Open `_Build/_Projects/XCode/SCExample.xcodeproj` and choose `Product` --> `Run` |
| Debug (VS2022)| Open `_Build/_Projects/VisualStudio2022/SCExample.sln` and start Debugging (F5) |

https://github.com/Pagghiu/SaneCppLibraries/assets/5406873/4ad12058-6bc2-4316-90f8-4ba4c05e28de
https://github.com/user-attachments/assets/2a38310c-6a28-4f86-a0f3-665dc15b126d
https://github.com/Pagghiu/SaneCppLibraries/assets/5406873/5c7d4036-6e0c-4262-ad57-9ef84c214717

\htmlonly
<iframe width="700" height="400" src="https://github.com/Pagghiu/SaneCppLibraries/assets/5406873/4ad12058-6bc2-4316-90f8-4ba4c05e28de" frameborder="0" allowfullscreen>
<iframe width="700" height="400" src="https://github.com/user-attachments/assets/2a38310c-6a28-4f86-a0f3-665dc15b126d" frameborder="0" allowfullscreen>
\endhtmlonly
\htmlonly
Expand Down
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,10 +88,10 @@ Shortly:

# Examples

Check the [Examples](https://pagghiu.github.io/SaneCppLibraries/page_examples.html) page.
SCExample showcases integration of Sane C++ Libraries together with [Dear ImGui](https://github.com/ocornut/imgui) and [sokol](https://github.com/floooh/sokol) libraries (see [Examples](https://pagghiu.github.io/SaneCppLibraries/page_examples.html) page).

## macOS
https://github.com/Pagghiu/SaneCppLibraries/assets/5406873/4ad12058-6bc2-4316-90f8-4ba4c05e28de
https://github.com/user-attachments/assets/2a38310c-6a28-4f86-a0f3-665dc15b126d

## iOS
https://github.com/Pagghiu/SaneCppLibraries/assets/5406873/5c7d4036-6e0c-4262-ad57-9ef84c214717
Expand Down Expand Up @@ -151,6 +151,7 @@ You can find some [YouTube Videos](https://www.youtube.com/@Pagghiu) and [Blog p
- [June 2024 Update](https://pagghiu.github.io/site/blog/2024-06-30-SaneCppLibrariesUpdate.html)

- [Ep.24 - Hot-Reload C++ on iOS](https://www.youtube.com/watch?v=6DfykfYCQdY)
- [Ep.25 - C++ Serialization and Reflection (with Hot-Reload)](https://www.youtube.com/watch?v=d7DXxC6xG_A)


# Contributing
Expand Down

0 comments on commit 4f797e4

Please sign in to comment.