Update README.md's to reflect latest project structure

README.md

@@ -76,6 +76,6 @@ development supported and stable.
   </tr>
 </table>
 
-We'd also like to thank the wider open-source community. OpenSim Creator wouldn't be
-possible without access to high-quality open-source libraries and technical literature
-from thousands of contributors.
+Finally, we would also like to thank the wider open-source community. OpenSim Creator
+wouldn't be possible without using and learning from high-quality open-source libraries
+and technical literature from thousands of contributors.

docs/README.md

@@ -1,4 +1,4 @@
-# `docs/`: OpenSim Creator's User-Facing Documentation
+# OpenSim Creator's User-Facing Documentation
 
 > The source code behind https://docs.opensimcreator.com, which is a user-facing
 > manual for the [OpenSim Creator Project](https://github.com/ComputationalBiomechanicsLab/opensim-creator).

libOpenSimCreator/README.md

@@ -1,15 +1,11 @@
-# `src/OpenSimCreator`: Implementation code for the OpenSim Creator UI
+# `libOpenSimCreator`: Implementation code for the OpenSim Creator UI
 
 This project directly integrates the [OpenSim API](https://github.com/opensim-org/opensim-core)
 against the `oscar` API.
 
 The general structure of this project is work-in-progress, primarly because
 I'm midway through refactoring `oscar` into a more sane layout.
 
-The implementation does not provide a `main` function (i.e. it's not an executable,
-but a library). See `opensim-creator/apps` for applications that use the library API
-to boot something.
-
 | Directory | Description |
 | - | - |
 | `ComponentRegistry/` | Support for OSC-specific registries that contain `OpenSim::Component`s with additional OSC-specific filtering, metadata, etc. |
@@ -18,3 +14,4 @@ to boot something.
 | `Platform/` | Application-wide systems (e.g. `OpenSimCreatorApp`) that may be used by various parts of the UI |
 | `UI/` | Code for rendering OpenSimCreator's 2D UI |
 | `Utils/` | Lightweight utility code that doesn't depend on any of the above |
+| `testing/` | Code related to unit tests |

liboscar/README.md

@@ -1,4 +1,4 @@
-# `liboscar`: The underlying engine that powers OpenSim Creator
+# `liboscar`: Engine code for CAD projects
 
 `liboscar` is the "engine" part of OpenSim Creator. It's designed to have
 a minimal, OpenSim-independent, dependency set while providing what's

osc/README.md

@@ -0,0 +1,4 @@
+# `osc`: Main Application Executable for OpenSim Creator
+
+This directory contains the necessary code to build and package a UI
+executable for `libOpenSimCreator` on each target platform.

third_party/README.md

@@ -17,6 +17,3 @@ long as OpenSim Creator's main build can find the necessary libraries, it doesn'
 matter where they came from (or whether they were built from here). This is
 useful to know if you plan on (e.g.) using an OS-provided LAPACK, or want to
 build against a different version of `osim`, etc.
-
-**note**: developers should update `README.osc` with the corresponding upstream
-version when not using `git submodule`s.