diff --git a/README.md b/README.md index 60cb652122..bad705f715 100644 --- a/README.md +++ b/README.md @@ -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. (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`) -3. Install development dependencies. Note: Check the package.json engine for our tested and supported node versions. +2. (Optional) Install the correct node version using [nvm](https://github.com/nvm-sh/nvm): - `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/).