diff options
| author | Thomas Rueckstiess <thomas@rueckstiess.net> | 2015-01-08 11:35:03 +1100 |
|---|---|---|
| committer | Thomas Rueckstiess <thomas@rueckstiess.net> | 2015-01-08 11:35:03 +1100 |
| commit | 3e90303af8c55e0f9ce0c5eecedc281f99bd04ad (patch) | |
| tree | 55ed1dc540fc944af596d25211e0764a7f5ed78f /tools | |
| parent | 042d082218ab1ccb5556970acede550eff9480b1 (diff) | |
| download | mongo-3e90303af8c55e0f9ce0c5eecedc281f99bd04ad.tar.gz | |
changes based on PR feedback
- included information about installing npm
- added link to package.json file for specific versions
- clarifications in various places
Diffstat (limited to 'tools')
| -rw-r--r-- | tools/template/README.md | 15 |
1 files changed, 10 insertions, 5 deletions
diff --git a/tools/template/README.md b/tools/template/README.md index 6ed0ffbd7b5..4e2cb348dd7 100644 --- a/tools/template/README.md +++ b/tools/template/README.md @@ -1,20 +1,24 @@ # wtstats template -This subfolder contains the code to generate the `wtstats.html.template` file needed by the Python script `wtstats.py`, which is located in the `./tools` directory. +This directory contains the code to generate the `wtstats.html.template` file needed by the Python script `wtstats.py`. The template is generated as a node.js "single page" application using several open source frameworks, see Dependencies below. The `wtstats.py` Python script parses stats files, transforms the data and inserts it as JSON into the template. The resulting HTML page can be openend in the browser. ### Build Process -To build the template, follow these steps: +To build the template, you need `npm` (node package manager). `npm` is included in the Node.js packages and source, which you can get at [http://nodejs.org/download/](). On Ubuntu, you can also install `npm` via `sudo apt-get install npm`. On AWS Linux, you can install `npm` via `sudo yum install npm --enablerepo=epel`. -1. change into the `./tools/template` directory +Once you have `npm` installed, follow these steps: + +1. change into the `./tools/template` directory (where this `README.md` is located) 2. run `npm install` to install all missing dependencies. -3. run `npm run build` to build the template, pack everything into a single HTML file and copy it to its parent folder as `./tools/wtstats.html.template`. +3. run `npm run build` to build the template. + +The build script packs everything into a single HTML file and copies it to its parent folder as `./tools/wtstats.html.template`. ### Usage -Call the `wtstats.py` Python script with a stats file as argument. The `test` subfolder contains a small example stats file to test: +Call the `wtstats.py` Python script located in the `./tools` directory with a stats file as argument. The `./tools/test` subfolder contains a small example stats file to test: ``` python wtstats.py ./test/WiredTigerStat.fixture @@ -33,6 +37,7 @@ For more information about _wtstats_ usage, check out the [wtstats documentation - [lodash](https://lodash.com/), object/array transformation, [MIT license][5] - [fontawesome](http://fontawesome.io/), icons, [OFL and MIT licenses][6] +For specific versions of these dependencies, see the [package.json](./package.json) file. [1]: https://github.com/AmpersandJS/ampersand-view/blob/master/LICENSE.md [2]: https://github.com/twbs/bootstrap/blob/master/LICENSE |