Skip to content

Commit

Permalink
docs(README) Added steps for running dingus on Windows
Browse files Browse the repository at this point in the history
Signed-off-by: Nishi Agrawal <[email protected]>
  • Loading branch information
nishihere19 committed Apr 4, 2021
1 parent a87d130 commit 0865dba
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 4 deletions.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
"private": true,
"scripts": {
"dingus": "lerna exec --scope dingus -- npm run dingus",
"dingus:win":"lerna exec --scope dingus -- npm run dingus:win",
"dingus:win": "lerna exec --scope dingus -- npm run dingus:win",
"build": "lerna run build",
"postinstall": "npm run models:get && lerna bootstrap",
"models:get": "node ./scripts/external/getExternalModels.js",
Expand Down
8 changes: 7 additions & 1 deletion packages/dingus/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,18 @@ An online tool which lets you edit the markdown and see it rendered as HTML, or

Further documentation can be found at [this link](https://docs.accordproject.org/docs/markup-preliminaries.html#dingus).

## Run Locally
## Run Locally on Linux

```sh
npm run dingus
open demo/index.html
```
## Run Locally on Windows

```sh
npm run dingus:win
open demo/index.html
```

## License <a name="license"></a>
Accord Project source code files are made available under the Apache License, Version 2.0 (Apache-2.0), located in the LICENSE file. Accord Project documentation files are made available under the Creative Commons Attribution 4.0 International License (CC-BY-4.0), available at http://creativecommons.org/licenses/by/4.0/.
4 changes: 2 additions & 2 deletions packages/dingus/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"license": "Apache-2.0",
"scripts": {
"dingus": "node ./scripts/build_dingus.js",
"dingus:win":"node ./scripts/build_dingus_win.js"
"dingus:win": "node ./scripts/build_dingus_win.js"
},
"files": [],
"dependencies": {},
Expand All @@ -39,4 +39,4 @@
"mocha": {
"inline-diffs": true
}
}
}

0 comments on commit 0865dba

Please sign in to comment.