diff --git a/example/README.md b/example/README.md new file mode 100644 index 0000000000..0e1b29c036 --- /dev/null +++ b/example/README.md @@ -0,0 +1,2 @@ +This directory is for example bundles, which are intended to illustrate +how to author new software components using Open MCT Web. diff --git a/platform/README.md b/platform/README.md new file mode 100644 index 0000000000..8415895a6c --- /dev/null +++ b/platform/README.md @@ -0,0 +1,2 @@ +This directory contains all bundles for the Open MCT Web platform, as well +as the framework which runs them. diff --git a/platform/commonUI/README.md b/platform/commonUI/README.md new file mode 100644 index 0000000000..f77df6aa2f --- /dev/null +++ b/platform/commonUI/README.md @@ -0,0 +1,3 @@ +This directory contains bundles containing common user interface +elements of Open MCT Web; that is, the user interface for the application +as a whole (as opposed to for specific features) is implemented here. diff --git a/platform/core/README.md b/platform/core/README.md new file mode 100644 index 0000000000..ff09897da2 --- /dev/null +++ b/platform/core/README.md @@ -0,0 +1,3 @@ +This bundle contains core software components of Open MCT Web. These +components describe MCT's information model, and are responsible for +introducing the API and infrastructure which supports domain objects. diff --git a/platform/data/README.md b/platform/data/README.md new file mode 100644 index 0000000000..664cabd7cb --- /dev/null +++ b/platform/data/README.md @@ -0,0 +1,2 @@ +This bundle is responsible for introducing a reusable infrastructure +and set of APIs for using time-series data in Open MCT Web. diff --git a/platform/features/README.md b/platform/features/README.md new file mode 100644 index 0000000000..24d5e45597 --- /dev/null +++ b/platform/features/README.md @@ -0,0 +1,3 @@ +This directory contains bundles which represent specific user-facing +features of Open MCT Web, such as plots and other visualizations. +Bundles in this directory should be effectively optional. diff --git a/platform/forms/README.md b/platform/forms/README.md new file mode 100644 index 0000000000..cc81b4ca86 --- /dev/null +++ b/platform/forms/README.md @@ -0,0 +1,3 @@ +This bundle contains a general implementation of forms in Open MCT Web. +This allows forms to be expressed using a reasonably concise declarative +syntax, and rendered as Angular templates in a consistent fashion. diff --git a/platform/framework/README.md b/platform/framework/README.md new file mode 100644 index 0000000000..4726e36268 --- /dev/null +++ b/platform/framework/README.md @@ -0,0 +1,5 @@ +Framework-level components for Open MCT Web. This is Angular and Require, +with an extra layer to mediate between them and act as an extension +mechanism to allow plug-ins to be introduced declaratively. + + diff --git a/platform/identity/README.md b/platform/identity/README.md new file mode 100644 index 0000000000..d22679a20c --- /dev/null +++ b/platform/identity/README.md @@ -0,0 +1,2 @@ +This bundle is responsible for introducing identity management features +and API to Open MCT Web. diff --git a/platform/persistence/README.md b/platform/persistence/README.md new file mode 100644 index 0000000000..468fc73f07 --- /dev/null +++ b/platform/persistence/README.md @@ -0,0 +1,2 @@ +This bundle implements a connection to an external CouchDB persistence +store in Open MCT Web. diff --git a/platform/representation/README.md b/platform/representation/README.md new file mode 100644 index 0000000000..f55da96608 --- /dev/null +++ b/platform/representation/README.md @@ -0,0 +1,4 @@ +This bundle introduces the notion of "representations" to Open MCT Web, +primarily via an Angular directive, `mct-representation`. + +A representation is used to display domain objects as Angular templates.