docs: explain directory structure

jenspots · Apr 14, 2024 · 99a440a · 99a440a
1 parent 6a1aecb
commit 99a440a
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 0 deletions.
diff --git a/include/README.md b/include/README.md
@@ -0,0 +1,3 @@
+## About
+
+This directory as a whole is exported to the end user. Typically, the only required import is [`<wheel.h>`](./wheel.h), which exports all other modules. Additionally, some implementations for standard library data types are provided in the [`std`](./wheel/std) directory and can be directly. For example, [`<wheel/std/int.h>`](./wheel/std/int.h) and [`<wheel/std/string.h>`](./wheel/std/string.h).
diff --git a/include/wheel/README.md b/include/wheel/README.md
@@ -0,0 +1,21 @@
+## About
+
+### [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.
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		## About

		This directory as a whole is exported to the end user. Typically, the only required import is [`<wheel.h>`](./wheel.h), which exports all other modules. Additionally, some implementations for standard library data types are provided in the [`std`](./wheel/std) directory and can be directly. For example, [`<wheel/std/int.h>`](./wheel/std/int.h) and [`<wheel/std/string.h>`](./wheel/std/string.h).