From f16c1222991fec9a4938a393d67b4fc8cc092c95 Mon Sep 17 00:00:00 2001 From: Zehua Liu Date: Mon, 25 Sep 2017 12:16:33 +0800 Subject: [PATCH] Added hint for node version min requirement jsdoc does not seem to work with node 5 or below - updated README - added .nvmrc - added engine section to package.json --- .nvmrc | 1 + README.md | 8 ++++++++ package.json | 1 + 3 files changed, 10 insertions(+) create mode 100644 .nvmrc diff --git a/.nvmrc b/.nvmrc new file mode 100644 index 00000000..1e8b3149 --- /dev/null +++ b/.nvmrc @@ -0,0 +1 @@ +6 diff --git a/README.md b/README.md index 6b2d3075..677ffbf6 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,14 @@ For more details on configuring the server, see [http-server docs][http-server]. ## Development +### Node version + +Node 6 or above is required in order to build jsdoc. + +If you are using [nvm](https://github.com/creationix/nvm#nvmrc), simply run: + + nvm install && nvm use + ### Building docs To rebuild the [docs](./docs/index.html) page: diff --git a/package.json b/package.json index e9beff2e..ee705f00 100644 --- a/package.json +++ b/package.json @@ -2,6 +2,7 @@ "name": "ramda.github.io", "version": "0.24.1", "description": "Ramda website", + "engines" : { "node" : ">=6.0.0" }, "private": true, "repository": { "type": "git",