Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/nasa/openmct.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorpacozaa <pacosarin@gmail.com>2016-07-13 11:05:11 +0300
committerpacozaa <pacosarin@gmail.com>2016-07-13 11:05:11 +0300
commit407766774dccd7b526ebe02a86fc210033ddfbf9 (patch)
tree088521395acf03909b0a417b40740f7391c642c1 /README.md
parent12b554495995838d6477c3d5e775661fd9e3526c (diff)
[Documentation] Add Building and Running Open MCT Locally Section from #1044 comment
Diffstat (limited to 'README.md')
-rw-r--r--README.md22
1 files changed, 20 insertions, 2 deletions
diff --git a/README.md b/README.md
index b81e441f1..5af8df5f5 100644
--- a/README.md
+++ b/README.md
@@ -9,11 +9,29 @@ Please visit our [Official Site](https://nasa.github.io/openmct/) and [Getting S
Try Open MCT now with our [live demo](https://openmct-demo.herokuapp.com/).
![Demo](https://nasa.github.io/openmct/static/res/images/Open-MCT.Browse.Layout.Mars-Weather-1.jpg)
+## Building and Running Open MCT Locally
+
+Building and running Open MCT in your local dev environment is very easy. Be sure you have Git and Node.js installed, then follow the directions below. Need additional information? Check out the [Getting Started](https://nasa.github.io/openmct/getting-started/) page on our website.
+
+1. Clone the source code
+
+ `git clone https://github.com/nasa/openmct.git`
+
+2. Install development dependencies
+
+ `npm install`
+
+3. Run a local development server
+
+ `npm start`
+
+Open MCT is now running, and can be accessed by pointing a web browser at http://localhost:8080/
+
## Documentation
-Check our [Documentation on website](https://nasa.github.io/openmct/documentation/).
+Documentation is available on the [Open MCT website](https://nasa.github.io/openmct/documentation/)
-You can also build it locally.
+The documentation can also be built locally.
### Building the Open MCT Documentation locally
Open MCT's documentation is generated by an