docs: explain directory structure

jenspots · Apr 14, 2024 · 36ec3c2 · 36ec3c2
1 parent 6a1aecb
commit 36ec3c2
Showing 1 changed file with 19 additions and 0 deletions.
diff --git a/include/wheel/README.md b/include/wheel/README.md
@@ -0,0 +1,19 @@
+## [Containers](./containers)
+
+The implementation of the various data structures in the library.
+
+## [Miscellaneous](./misc)
+
+Various utilities and helper functions.
+
+## [STD](./std)
+
+Instantiations of the data structures with common types.
+
+## [Traits](./traits)
+
+The traits that can be implemented by the user to extend the library.
+
+## [Wheel](./wheel)
+
+A meta module that re-exports all the other modules.