From 94eadedb9fa636bd8b183e9d0a4bbe9ffa5b1c49 Mon Sep 17 00:00:00 2001 From: Edward Snare Date: Sat, 30 Mar 2019 15:04:00 +0200 Subject: [PATCH] Update README documentation --- README.md | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index ef767a0107..126e4b627f 100644 --- a/README.md +++ b/README.md @@ -30,19 +30,20 @@ This project is built on top of [Angular CLI](https://github.com/angular/angular ## Developing -Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files. +Install project dependencies and start a local server with the following terminal commands: -``` +```bash $ npm install $ npm run start -$ npm run markdown:watch ``` -All pages are written in the [markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) and located in the `content` directory. Run `npm run markdown:watch` to compile them to HTML files on file change. +Navigate to [`http://localhost:4200/`](http://localhost:4200/). + +All pages are written in [markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) and located in the `content` directory. Run `npm run markdown:watch` to compile them to HTML files on file change. ## Build -Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `-prod` flag for a production build. +Run `npm run build` to build the project. The build artifacts will be stored in the `dist/` directory. Use `npm run build:prod` for a production build. ## Support