summaryrefslogtreecommitdiff
path: root/docs/dev/quickstart.rst
diff options
context:
space:
mode:
authorMarkus Heiser <markus.heiser@darmarit.de>2021-11-14 18:10:14 +0100
committerMarkus Heiser <markus.heiser@darmarit.de>2021-11-16 23:31:11 +0100
commitdc1442a2d1dbca5007833b14e34aa7f407801706 (patch)
treece32f0f67ee80732789dd0c96c4a9115be5c4c35 /docs/dev/quickstart.rst
parent646db5d4f942b4c4da4a62f38b159bd80b7f9db1 (diff)
[mod] Tools to install and maintain NVM versions manager for Node.js
[1] https://github.com/nvm-sh/nvm Signed-off-by: Markus Heiser <markus.heiser@darmarit.de>
Diffstat (limited to 'docs/dev/quickstart.rst')
-rw-r--r--docs/dev/quickstart.rst33
1 files changed, 12 insertions, 21 deletions
diff --git a/docs/dev/quickstart.rst b/docs/dev/quickstart.rst
index fee09216e..7e4ce8b68 100644
--- a/docs/dev/quickstart.rst
+++ b/docs/dev/quickstart.rst
@@ -5,6 +5,7 @@ Development Quickstart
======================
.. _npm: https://www.npmjs.com/
+.. _Node.js: https://nodejs.org/
SearXNG loves developers, just clone and start hacking. All the rest is done for
you simply by using :ref:`make <makefile>`.
@@ -24,37 +25,27 @@ choose a meaningful commit message and we are happy to receive your pull
request. To not end in *wild west* we have some directives, please pay attention
to our ":ref:`how to contribute`" guideline.
-If you implement themes, you will need to compile styles and JavaScript before
-*run*.
+If you implement themes, you will need to setup a :ref:`make node.env` once:
.. code:: sh
- make themes.all
-
-Don't forget to install npm_ first.
-
-.. tabs::
-
- .. group-tab:: Ubuntu / debian
-
- .. code:: sh
+ make node.env
- sudo -H apt-get install npm
+Before you call *make run* (2.), you need to compile the modified styles and
+JavaScript:
- .. group-tab:: Arch Linux
-
- .. code-block:: sh
-
- sudo -H pacman -S npm
+.. code:: sh
- .. group-tab:: Fedora / RHEL
+ make themes.all
- .. code-block:: sh
+Alternatively you can also compile selective the theme you have modified,
+e.g. the *simple* theme.
+.. code:: sh
- sudo -H dnf install npm
+ make themes.simple
If you finished your *tests* you can start to commit your changes. To separate
-the changed code from the build products first run:
+the modified source code from the build products first run:
.. code:: sh