changeset 8613:0765771dbe5a

docs: clarify the need for having 'npm' and 'node' available in $PATH
author Mads Kiilerich <mads@kiilerich.com>
date Thu, 13 Aug 2020 15:24:35 +0200
parents 4d742b172010
children 43d9615facc6
files docs/installation.rst docs/overview.rst
diffstat 2 files changed, 9 insertions(+), 5 deletions(-) [+]
line wrap: on
line diff
--- a/docs/installation.rst	Thu Aug 13 19:04:00 2020 +0200
+++ b/docs/installation.rst	Thu Aug 13 15:24:35 2020 +0200
@@ -141,9 +141,13 @@
 Prepare front-end files
 -----------------------
 
-Finally, the front-end files must be prepared. This requires ``npm`` version 6
-or later, which needs ``node.js`` (version 12 or later). Prepare the front-end
-by running::
+Finally, the front-end files with CSS and JavaScript must be prepared. This
+depends on having some commands available in the shell search path: ``npm``
+version 6 or later, and ``node.js`` (version 12 or later) available as
+``node``. The installation method for these dependencies varies between
+operating systems and distributions.
+
+Prepare the front-end by running::
 
     kallithea-cli front-end-build
 
--- a/docs/overview.rst	Thu Aug 13 19:04:00 2020 +0200
+++ b/docs/overview.rst	Thu Aug 13 15:24:35 2020 +0200
@@ -21,8 +21,8 @@
     This makes the ``kallithea-cli`` command line tool available.
 
 3. **Prepare front-end files**
-    Some front-end files must be fetched or created using ``npm`` tooling so
-    they can be served to the client as static files.
+    Some front-end files must be fetched or created using ``npm`` and ``node``
+    tooling so they can be served to the client as static files.
 
 4. **Create low level configuration file.**
     Use ``kallithea-cli config-create`` to create a ``.ini`` file with database