diff options
| author | Matej Cotman <cotman.matej@gmail.com> | 2014-01-12 12:40:27 +0100 |
|---|---|---|
| committer | Matej Cotman <cotman.matej@gmail.com> | 2014-01-14 23:31:15 +0100 |
| commit | e740c8a8ea7dc4bbda7dab9a63ec476167c209ef (patch) | |
| tree | 19fc35d68eb6570b4d4c8b04cf1f82a7d304dddc /README.md | |
| parent | 348187cff9bc3c55c1327f3d7177e6d1a61b8430 (diff) | |
tests and robot tests framework, build overhaul
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 44 |
1 files changed, 44 insertions, 0 deletions
@@ -29,6 +29,48 @@ List of [running instances](https://github.com/asciimoo/searx/wiki/Searx-instanc For all the details, follow this [step by step installation](https://github.com/asciimoo/searx/wiki/Installation) +### Alternative (Recommended) Installation + +* clone source: `git clone git@github.com:asciimoo/searx.git && cd searx` +* build in current folder: `make minimal` +* run `bin/searx-run` to start the application + + +### Development + +Just run `make`. Versions of dependencies are pinned down inside `versions.cfg` to produce most stable build. + +#### Command make + +##### `make` + +Builds development environment with testing support. + +##### `make tests` + +Runs tests. You can write tests [here](https://github.com/asciimoo/searx/tree/master/searx/tests) and remember 'untested code is broken code'. + +##### `make robot` + +Runs robot (Selenium) tests, you must have `firefox` installed because this functional tests actually run the browser and perform operations on it. Also searx is executed with [settings_robot](https://github.com/asciimoo/searx/blob/master/searx/settings_robot.py). + +##### `make flake8` + +'pep8 is a tool to check your Python code against some of the style conventions in [PEP 8](http://www.python.org/dev/peps/pep-0008/).' + +##### `make coverage` + +Checks coverage of tests, after running this, execute this: `firefox ./coverage/index.html` + +##### `make minimal` + +Used to make co-called production environment - without tests (you should ran tests before deploying searx on the server). + +##### `make clean` + +Deletes several folders and files (see `Makefile` for more), so that next time you run any other `make` command it will rebuild everithing. + + ### TODO * Moar engines @@ -36,7 +78,9 @@ For all the details, follow this [step by step installation](https://github.com/ * Language support * Documentation * Pagination +* Fix `flake8` errors, `make flake8` will be merged into `make tests` when it does not fail anymore * Tests +* When we have more tests, we can integrate Travis-CI ### Bugs |