summaryrefslogtreecommitdiff
path: root/docs/dev/makefile.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/dev/makefile.rst')
-rw-r--r--docs/dev/makefile.rst14
1 files changed, 9 insertions, 5 deletions
diff --git a/docs/dev/makefile.rst b/docs/dev/makefile.rst
index f5957001c..ed9942f4c 100644
--- a/docs/dev/makefile.rst
+++ b/docs/dev/makefile.rst
@@ -11,6 +11,8 @@ Makefile Targets
Before looking deeper at the targets, first read about :ref:`makefile setup`
and :ref:`make pyenv`.
+ To install system requirements follow :ref:`buildhosts`.
+
With the aim to simplify development cycles, started with :pull:`1756` a
``Makefile`` based boilerplate was added. If you are not familiar with
Makefiles, we recommend to read gnu-make_ introduction.
@@ -37,15 +39,17 @@ Calling the ``help`` target gives a first overview::
.. _makefile setup:
-Setup
-=====
+Makefile setup
+==============
.. _git stash: https://git-scm.com/docs/git-stash
-The main setup is done in the :origin:`Makefile`::
+The main setup is done in the :origin:`.config.sh` (read :ref:`toolboxing
+setup`)::
- export GIT_URL=https://github.com/asciimoo/searx
export SEARX_URL=https://searx.me
+
+ export GIT_URL=https://github.com/asciimoo/searx
export DOCS_URL=https://asciimoo.github.io/searx
.. sidebar:: fork & upstream
@@ -170,7 +174,7 @@ e.g.:
.. code:: sh
- $ make test.pep8 test.unit
+ $ make test.pep8 test.unit test.sh
. ./local/py3/bin/activate; ./manage.sh pep8_check
[!] Running pep8 check
. ./local/py3/bin/activate; ./manage.sh unit_tests