From 681013b84b9fd3b1c2e9c03a1749a38000d6da9f Mon Sep 17 00:00:00 2001 From: Vladimir Mandic Date: Wed, 17 Mar 2021 12:01:54 -0400 Subject: [PATCH] hierarchical readme notes --- assets/README.md | 4 ++++ demo/README.md | 5 +++++ models/README.md | 5 +++++ server/README.md | 6 ++++++ src/README.md | 11 +++++++++++ 5 files changed, 31 insertions(+) create mode 100644 assets/README.md create mode 100644 demo/README.md create mode 100644 models/README.md create mode 100644 server/README.md create mode 100644 src/README.md diff --git a/assets/README.md b/assets/README.md new file mode 100644 index 00000000..1b1d4124 --- /dev/null +++ b/assets/README.md @@ -0,0 +1,4 @@ +# Human Library: Demos + +Static assets used by `Human` library demos and/or referenced by Wiki pages + diff --git a/demo/README.md b/demo/README.md new file mode 100644 index 00000000..3a331aab --- /dev/null +++ b/demo/README.md @@ -0,0 +1,5 @@ +# Human Library: Demos + +For details see Wiki: + +- [**Demos**](https://github.com/vladmandic/human/wiki/Demos) diff --git a/models/README.md b/models/README.md new file mode 100644 index 00000000..4618f458 --- /dev/null +++ b/models/README.md @@ -0,0 +1,5 @@ +# Human Library: Models + +For details see Wiki: + +- [**List of Models & Credits**](https://github.com/vladmandic/human/wiki/Models) diff --git a/server/README.md b/server/README.md new file mode 100644 index 00000000..d6da6819 --- /dev/null +++ b/server/README.md @@ -0,0 +1,6 @@ +# Human Library: Dev Server & Build Scripts + +For details see Wiki: + +- [**Build Process**](https://github.com/vladmandic/human/wiki/Build-Process) +- [**Development Server**](https://github.com/vladmandic/human/wiki/Development-Server) diff --git a/src/README.md b/src/README.md new file mode 100644 index 00000000..83bc09b8 --- /dev/null +++ b/src/README.md @@ -0,0 +1,11 @@ +# Human Library: Sources + +Source code of the `Human` library + +- Compiled and bundled code for different targets are present in `/dist` +- Compiled typings are present in `/types` +- Extracted API specification is present in `/typedoc` + +For details how to build the `Human` library see Wiki + +- [**Build Process**](https://github.com/vladmandic/human/wiki/Build-Process)