From f11cd589c5bbfc406f0e2fe0b5191f9d9da8b3d5 Mon Sep 17 00:00:00 2001 From: Victor Woeltjen Date: Tue, 2 Feb 2016 16:06:45 -0800 Subject: [PATCH] [Build] Summarize dist contents --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index da0de966ea..a690b35156 100644 --- a/README.md +++ b/README.md @@ -63,6 +63,14 @@ To build: `npm run prepublish` +This will compile and minify JavaScript sources, as well as copy over assets. +The contents of the `dist` folder will contain a runnable Open MCT Web +instance (e.g. by starting an HTTP server in that directory), including: + +* A `main.js` file containing Open MCT Web source code. +* Various assets in the `example` and `platform` directories. +* An `index.html` that runs Open MCT Web in its default configuration. + Additional `gulp` tasks are defined in [the gulpfile](gulpfile.js). ### Building Documentation