From fb9ac92f0954edb07da221b8691f4a2254d1ecd8 Mon Sep 17 00:00:00 2001 From: Eric Goller Date: Mon, 9 Apr 2018 15:23:58 +0200 Subject: [PATCH] Expand readme with jsdoc related information Ref.: #254 --- README.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/README.rst b/README.rst index e3357151..1432515b 100644 --- a/README.rst +++ b/README.rst @@ -51,6 +51,17 @@ it:: Now you are all setup to run ``make develop`` and related make targets without changing you main environment. +The following is only needed if you wish to build the documentation. + +After you ran ``make develop``, create a new *node virtual env* with (the freshly installed) +``nodeenv``:: + + nodeenv .nodeenv + source .nodeenv/bin/activate + +Finally use npm to setup jsdoc in your virtual node environment:: + npm install -g jsdoc + Manual Installation For Testing and Development ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ Clone the repository::