ExternalVendorCode/openmct
1
0
Fork 0
mirror of https://github.com/nasa/openmct.git synced 2024-12-19 05:07:52 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs(readme): indent correctly (#6996)

Browse Source 
* fix(readme): indent correctly

* fix(readme): review

* fix(readme): review

* chore(docs): revise

Co-authored-by: Jesse Mazzella <ozyx@users.noreply.github.com>

* docs: tidy up a bit

---------

Co-authored-by: Jesse Mazzella <ozyx@users.noreply.github.com>
Co-authored-by: Jesse Mazzella <jesse.d.mazzella@nasa.gov>
This commit is contained in:
Even Stensberg 2023-08-28 21:59:25 +02:00 committed by GitHub
parent cbac2c1c82
commit f9db6433a1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -16,20 +16,32 @@ Once you've created something amazing with Open MCT, showcase your work in our G
Building and running Open MCT in your local dev environment is very easy. Be sure you have [Git](https://git-scm.com/downloads) and [Node.js](https://nodejs.org/) 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. Building and running Open MCT in your local dev environment is very easy. Be sure you have [Git](https://git-scm.com/downloads) and [Node.js](https://nodejs.org/) 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.
(These instructions assume you are installing as a non-root user; developers have [reported issues](https://github.com/nasa/openmct/issues/1151) running these steps with root privileges.) (These instructions assume you are installing as a non-root user; developers have [reported issues](https://github.com/nasa/openmct/issues/1151) running these steps with root privileges.)
1. Clone the source code 1. Clone the source code:
`git clone https://github.com/nasa/openmct.git` ```
git clone https://github.com/nasa/openmct.git
```
2. (Optionally) Install the correct node version using [nvm](https://github.com/nvm-sh/nvm) (`nvm install`) 2. (Optional) Install the correct node version using [nvm](https://github.com/nvm-sh/nvm):
3. Install development dependencies. Note: Check the package.json engine for our tested and supported node versions.
`npm install` ```
nvm install
```
4. Run a local development server 3. Install development dependencies (Note: Check the `package.json` engine for our tested and supported node versions):
`npm start` ```
npm install
```
Open MCT is now running, and can be accessed by pointing a web browser at [http://localhost:8080/](http://localhost:8080/) 4. Run a local development server:
```
npm start
```
> [!IMPORTANT]
> Open MCT is now running, and can be accessed by pointing a web browser at [http://localhost:8080/](http://localhost:8080/)
Open MCT is built using [`npm`](http://npmjs.com/) and [`webpack`](https://webpack.js.org/). Open MCT is built using [`npm`](http://npmjs.com/) and [`webpack`](https://webpack.js.org/).