From c043e0f1b372dc9ab409e0b0d1e4ff9108af135b Mon Sep 17 00:00:00 2001 From: Adam Kewley Date: Mon, 16 Sep 2024 15:18:41 +0200 Subject: [PATCH] Update README.md --- src/README.md | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/src/README.md b/src/README.md index 876cb3aab..996321df1 100644 --- a/src/README.md +++ b/src/README.md @@ -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` |