diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 45 |
1 files changed, 45 insertions, 0 deletions
diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..a0bb12f --- /dev/null +++ b/README.rst @@ -0,0 +1,45 @@ +searx +===== + +A privacy-respecting, hackable `metasearch +engine <https://en.wikipedia.org/wiki/Metasearch_engine>`__. + +List of `running +instances <https://github.com/asciimoo/searx/wiki/Searx-instances>`__. + +See the `documentation <https://asciimoo.github.io/searx>`__ and the `wiki <https://github.com/asciimoo/searx/wiki>`__ for more information. + +|Flattr searx| + +Installation +~~~~~~~~~~~~ + +- clone source: + ``git clone https://github.com/asciimoo/searx.git && cd searx`` +- install dependencies: ``./manage.sh update_packages`` +- edit your + `settings.yml <https://github.com/asciimoo/searx/blob/master/searx/settings.yml>`__ + (set your ``secret_key``!) +- run ``python searx/webapp.py`` to start the application + +For all the details, follow this `step by step +installation <https://github.com/asciimoo/searx/wiki/Installation>`__ + +Bugs +~~~~ + +Bugs or suggestions? Visit the `issue +tracker <https://github.com/asciimoo/searx/issues>`__. + +`License <https://github.com/asciimoo/searx/blob/master/LICENSE>`__ +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +More about searx +~~~~~~~~~~~~~~~~ + +- `ohloh <https://www.ohloh.net/p/searx/>`__ +- `twitter <https://twitter.com/Searx_engine>`__ +- IRC: #searx @ freenode + +.. |Flattr searx| image:: http://api.flattr.com/button/flattr-badge-large.png + :target: https://flattr.com/submit/auto?user_id=asciimoo&url=https://github.com/asciimoo/searx&title=searx&language=&tags=github&category=software |