Skip to content

Commit

Permalink
Update README documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
edwardsnare committed Mar 30, 2019
1 parent 1f2f1d8 commit 94eaded
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 94eaded

Please sign in to comment.