@@ -0,0 +1,90 @@
1+Development Quickstart
2+----------------------
3+
4+This quickstart guide gets your environment set up with searx. Furthermore, it gives a
5+short introduction to the new manage.sh script.
6+
7+How to setup your development environment
8+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
9+
10+First, clone the source code of searx to the desired folder. In this case the source
11+is cloned to ~/myprojects/searx. Then create and activate the searx-ve
12+virtualenv and install the required packages using manage.sh.
13+
14+.. code:: sh
15+
16+ cd ~/myprojects
17+ git clone https://github.com/asciimoo/searx.git
18+ cd searx
19+ virtualenv searx-ve
20+ . ./searx-ve/bin/activate
21+ ./manage.sh update_dev_packages
22+
23+
24+How to run tests
25+~~~~~~~~~~~~~~~~
26+
27+Tests can be run using the manage.sh script.
28+
29+Following tests and checks are available:
30+
31+- Unit tests
32+
33+- Selenium tests
34+
35+- PEP8 validation
36+
37+- Unit test coverage check
38+
39+For example unit tests are run with the command below:
40+
41+.. code:: sh
42+
43+ ./manage.sh unit_tests
44+
45+For further test options, please consult the help of the manage.sh script.
46+
47+
48+How to compile styles and javascript
49+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
50+
51+How to build styles
52+^^^^^^^^^^^^^^^^^^^
53+
54+Less is required to build the styles of searx. Less can be installed using either NodeJS or Apt.
55+
56+.. code:: sh
57+
58+ sudo apt-get install nodejs
59+ sudo npm install -g less
60+
61+
62+OR
63+
64+.. code:: sh
65+
66+ sudo apt-get install node-less
67+
68+After satisfying the requirements styles can be build using manage.sh
69+
70+.. code:: sh
71+
72+ ./manage.sh styles
73+
74+
75+How to build the source of the oscar theme
76+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
77+
78+Grunt must be installed in order to build the javascript sources. It depends on NodeJS, so first
79+Node has to be installed.
80+
81+.. code:: sh
82+
83+ sudo apt-get install nodejs
84+ sudo npm install -g grunt-cli
85+
86+After installing grunt, the files can be built using the following command:
87+
88+.. code:: sh
89+
90+ ./manage.sh build_grunt