Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
adamkewley committed Sep 16, 2024
1 parent ccc54b2 commit c043e0f
Showing 1 changed file with 7 additions and 8 deletions.
15 changes: 7 additions & 8 deletions src/README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,18 @@
# `src/`: OpenSim Creator's Source Code (Libraries)

This directory containing the core source code of OpenSimCreator, which is exposed
as (cmake-based) library targets that the downstream targets (e.g. the `osc` binary)
link to.
as (cmake-based) library targets that the downstream targets (e.g. the `osc` application
executable) link to.

OpenSim Creator is split into several independent library components. The intent
of each is:
OpenSim Creator is split into several independent library targets. The intent of each is:

| Directory | Description | Depends on |
| - | - | - |
| `OpenSimCreator/` | Implements the OpenSim Creator UI by integrating [OpenSim](https://github.com/opensim-org/opensim-core) against `oscar`. Also includes the demo/OpenGL tabs etc. for testing/verification. | `OpenSimThirdPartyPlugins`, `oscar`, `oscar_bookofshaders`, `oscar_demos`, `oscar_learnopengl`, `oscar_simbody`, `opensim-core` |
| `OpenSimThirdPartyPlugins` | Copy+paste of third-party OpenSim plugins | `opensim-core` |
| `oscar/` | OpenSim-independent framework for creating scientific tooling UIs | `OpenGL`, `glew`, `SDL2`, `nativefiledialog`, `imgui`, `IconFontCppHeaders`, `ImGuizmo`, `implot`, `stb`, `lunasvg`, `tomlplusplus`, `unordered_dense` |
| `oscar_bookofshaders/` | Implements https://thebookofshaders.com/ in terms of the `oscar` API | `oscar` |
| `OpenSimThirdPartyPlugins` | Copy+paste of third-party OpenSim plugins that were written by the community and are (usually) available on SimTK.org | `opensim-core` |
| `oscar/` | OpenSim-independent framework for creating scientific tooling UIs | `OpenGL`, `glew`, `SDL2`, `nativefiledialog`, `imgui`, `ImGuizmo`, `implot`, `stb`, `lunasvg`, `tomlplusplus`, `unordered_dense` |
| `oscar_bookofshaders/` | Demos that implement https://thebookofshaders.com/ in terms of the `oscar` API | `oscar` |
| `oscar_compiler_configuration/` | Compiler configuration options for `oscar` and `OpenSimCreator` | (nothing) |
| `oscar_demos/` | Demos that uses the `oscar` API to provide something interesting/useful | `oscar` |
| `oscar_learnopengl/` | Implements https://learnopengl.com/ in terms of the `oscar` API | `oscar` |
| `oscar_learnopengl/` | Demos that implment almost all https://learnopengl.com/ tutorials in terms of the `oscar` API | `oscar` |
| `oscar_simbody` | OpenSim-independent bindings between [simbody](https://github.com/simbody/simbody) | `oscar` |

0 comments on commit c043e0f

Please sign in to comment.