diff options
Diffstat (limited to 'README.rst')
| -rw-r--r-- | README.rst | 34 |
1 files changed, 26 insertions, 8 deletions
diff --git a/README.rst b/README.rst index a0bb12f19..a7b75d6e2 100644 --- a/README.rst +++ b/README.rst @@ -4,17 +4,32 @@ searx A privacy-respecting, hackable `metasearch engine <https://en.wikipedia.org/wiki/Metasearch_engine>`__. +Pronunciation: səːks + List of `running -instances <https://github.com/asciimoo/searx/wiki/Searx-instances>`__. +instances <https://searx.space/>`__. See the `documentation <https://asciimoo.github.io/searx>`__ and the `wiki <https://github.com/asciimoo/searx/wiki>`__ for more information. -|Flattr searx| +|OpenCollective searx backers| +|OpenCollective searx sponsors| Installation ~~~~~~~~~~~~ -- clone source: +With Docker +----------- +Go to the `searx-docker <https://github.com/searx/searx-docker>`__ project. + +Without Docker +-------------- +For all of the details, follow this `step by step installation <https://asciimoo.github.io/searx/admin/installation.html>`__. + +Note: the documentation needs to be updated. + +If you are in a hurry +--------------------- +- clone the source: ``git clone https://github.com/asciimoo/searx.git && cd searx`` - install dependencies: ``./manage.sh update_packages`` - edit your @@ -22,8 +37,6 @@ Installation (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 ~~~~ @@ -37,9 +50,14 @@ tracker <https://github.com/asciimoo/searx/issues>`__. More about searx ~~~~~~~~~~~~~~~~ -- `ohloh <https://www.ohloh.net/p/searx/>`__ +- `openhub <https://www.openhub.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 + +.. |OpenCollective searx backers| image:: https://opencollective.com/searx/backers/badge.svg + :target: https://opencollective.com/searx#backer + + +.. |OpenCollective searx sponsors| image:: https://opencollective.com/searx/sponsors/badge.svg + :target: https://opencollective.com/searx#sponsor |