mirror of
https://github.com/nasa/openmct.git
synced 2024-12-24 07:16:39 +00:00
[Documentation] Edit as Reqeust in #1044 comment
This commit is contained in:
parent
eef08ccb0b
commit
12b5544959
67
README.md
67
README.md
@ -1,56 +1,39 @@
|
||||
# Open MCT
|
||||
|
||||
Open MCT is a next-generation mission control framework being developed at the NASA Ames Research Center in Silicon Valley. Web-based, for desktop and mobile.
|
||||
Open MCT is a next-generation mission control framework for visualization of data on desktop and mobile devices. It is developed at NASA's Ames Research Center, and is being used by NASA for data analysis of spacecraft missions, as well as planning and operation of experimental rover systems. As a generalizable and open source framework, Open MCT could be used as the basis for building applications for planning, operation, and analysis of any systems producing telemetry data.
|
||||
|
||||
Please visit our [Official Site](https://nasa.github.io/openmct/)
|
||||
|
||||
##How is NASA Using Open MCT?
|
||||
|
||||
Software based on Open MCT is being used for mission planning and operations in the lead up to the [Resource Prospector mission](https://www.nasa.gov/resource-prospector) and at NASA's Jet Propulsion Laboratory to view data from the Curiosity Rover.
|
||||
|
||||
##Features
|
||||
|
||||
- Support planning and operations of any system that produces telemetry
|
||||
- Support space missions
|
||||
- Visualize Data
|
||||
- Streaming Data
|
||||
- Historical Data
|
||||
- Imagery
|
||||
- Timelines
|
||||
- Procedures
|
||||
- etc.
|
||||
Please visit our [Official Site](https://nasa.github.io/openmct/) and [Getting Started Guide](https://nasa.github.io/openmct/getting-started/)
|
||||
|
||||
## See Open MCT in Action
|
||||
|
||||
Do you want to see how Open MCT work? Try our demo.
|
||||
[LIVE DEMO](https://openmct-demo.herokuapp.com/)
|
||||
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)
|
||||
|
||||
##Getting Started
|
||||
## Documentation
|
||||
|
||||
Here is how to run Open MCT in you local machine.
|
||||
Check our [Documentation on website](https://nasa.github.io/openmct/documentation/).
|
||||
|
||||
1. Download or Clone Open MCT
|
||||
`git clone https://github.com/nasa/openmct.git`
|
||||
You can also build it locally.
|
||||
|
||||
2. Install Development Dependencies
|
||||
`npm install`
|
||||
### Building the Open MCT Documentation locally
|
||||
Open MCT's documentation is generated by an
|
||||
[npm](https://www.npmjs.com/)-based build. It has additional dependencies that
|
||||
may not be available on every platform and thus is not covered in the standard
|
||||
npm install. Ensure your system has [libcairo](http://cairographics.org/)
|
||||
installed and then run the following commands:
|
||||
|
||||
3. Run on your local machine
|
||||
`npm start`
|
||||
* `npm install`
|
||||
* `npm install canvas nomnoml`
|
||||
* `npm run docs`
|
||||
|
||||
4. Open your web browser and go to http://localhost:8080/
|
||||
Documentation will be generated in `target/docs`.
|
||||
|
||||
5. Wait for splash screen finish then you should be able to play with Open MCT.
|
||||
|
||||
For more information on building and running Open MCT, please see our getting started guide - https://nasa.github.io/openmct/getting-started/
|
||||
|
||||
## Build
|
||||
## Deploying Open MCT
|
||||
|
||||
Open MCT is built using [`npm`](http://npmjs.com/)
|
||||
and [`gulp`](http://gulpjs.com/).
|
||||
|
||||
To build:
|
||||
To build Open MCT for deployment:
|
||||
|
||||
`npm run prepublish`
|
||||
|
||||
@ -64,20 +47,6 @@ instance (e.g. by starting an HTTP server in that directory), including:
|
||||
|
||||
Additional `gulp` tasks are defined in [the gulpfile](gulpfile.js).
|
||||
|
||||
### Building Documentation
|
||||
|
||||
Open MCT's documentation is generated by an
|
||||
[npm](https://www.npmjs.com/)-based build. It has additional dependencies that
|
||||
may not be available on every platform and thus is not covered in the standard
|
||||
npm install. Ensure your system has [libcairo](http://cairographics.org/)
|
||||
installed and then run the following commands:
|
||||
|
||||
* `npm install`
|
||||
* `npm install canvas nomnoml`
|
||||
* `npm run docs`
|
||||
|
||||
Documentation will be generated in `target/docs`.
|
||||
|
||||
## Bundles
|
||||
|
||||
A bundle is a group of software components (including source code, declared
|
||||
|
Loading…
Reference in New Issue
Block a user