1
- # Open MCT Web
1
+ # Open MCT
2
2
3
- Open MCT Web is a web-based platform for mission operations user interface
3
+ Open MCT is a web-based platform for mission operations user interface
4
4
software.
5
5
6
6
## Bundles
7
7
8
8
A bundle is a group of software components (including source code, declared
9
9
as AMD modules, as well as resources such as images and HTML templates)
10
10
that are intended to be added or removed as a single unit. A plug-in for
11
- Open MCT Web will be expressed as a bundle; platform components are also
11
+ Open MCT will be expressed as a bundle; platform components are also
12
12
expressed as bundles.
13
13
14
14
A bundle is also just a directory which contains a file ` bundle.json ` ,
15
15
which declares its contents.
16
16
17
17
The file ` bundles.json ` (note the plural), at the top level of the
18
18
repository, is a JSON file containing an array of all bundles (expressed as
19
- directory names) to include in a running instance of Open MCT Web . Adding or
19
+ directory names) to include in a running instance of Open MCT. Adding or
20
20
removing paths from this list will add or remove bundles from the running
21
21
application.
22
22
@@ -56,26 +56,26 @@ To run:
56
56
57
57
## Build
58
58
59
- Open MCT Web is built using [ ` npm ` ] ( http://npmjs.com/ )
59
+ Open MCT is built using [ ` npm ` ] ( http://npmjs.com/ )
60
60
and [ ` gulp ` ] ( http://gulpjs.com/ ) .
61
61
62
62
To build:
63
63
64
64
` npm run prepublish `
65
65
66
66
This will compile and minify JavaScript sources, as well as copy over assets.
67
- The contents of the ` dist ` folder will contain a runnable Open MCT Web
67
+ The contents of the ` dist ` folder will contain a runnable Open MCT
68
68
instance (e.g. by starting an HTTP server in that directory), including:
69
69
70
- * A ` main.js ` file containing Open MCT Web source code.
70
+ * A ` main.js ` file containing Open MCT source code.
71
71
* Various assets in the ` example ` and ` platform ` directories.
72
- * An ` index.html ` that runs Open MCT Web in its default configuration.
72
+ * An ` index.html ` that runs Open MCT in its default configuration.
73
73
74
74
Additional ` gulp ` tasks are defined in [ the gulpfile] ( gulpfile.js ) .
75
75
76
76
### Building Documentation
77
77
78
- Open MCT Web 's documentation is generated by an
78
+ Open MCT's documentation is generated by an
79
79
[ npm] ( https://www.npmjs.com/ ) -based build. It has additional dependencies that
80
80
may not be available on every platform and thus is not covered in the standard
81
81
npm install. Ensure your system has [ libcairo] ( http://cairographics.org/ )
@@ -89,7 +89,7 @@ Documentation will be generated in `target/docs`.
89
89
90
90
# Glossary
91
91
92
- Certain terms are used throughout Open MCT Web with consistent meanings
92
+ Certain terms are used throughout Open MCT with consistent meanings
93
93
or conventions. Any deviations from the below are issues and should be
94
94
addressed (either by updating this glossary or changing code to reflect
95
95
correct usage.) Other developer documentation, particularly in-line
@@ -112,7 +112,7 @@ documentation, may presume an understanding of these terms.
112
112
(Most often used in the context of extensions, domain
113
113
object models, or other similar application-specific objects.)
114
114
* _ domain object_ : A meaningful object to the user; a distinct thing in
115
- the work support by Open MCT Web . Anything that appears in the left-hand
115
+ the work support by Open MCT. Anything that appears in the left-hand
116
116
tree is a domain object.
117
117
* _ extension_ : An extension is a unit of functionality exposed to the
118
118
platform in a declarative fashion by a bundle. For more
0 commit comments