forked from zaclys/searxng
[mod] update README.rst / differences to searx
* add "Differences to searx" section * normalize some reST markup & trailing whitespace * Use `===` and `----` to markup chapters & sections (like we use in other documentations). Co-authored-by: Markus Heiser <markus.heiser@darmarit.de> Co-authored-by: Alexandre Flament <alex@al-f.net>
This commit is contained in:
parent
32874dbf7f
commit
f88dec444b
89
README.rst
89
README.rst
|
@ -1,11 +1,21 @@
|
||||||
.. SPDX-License-Identifier: AGPL-3.0-or-later
|
.. SPDX-License-Identifier: AGPL-3.0-or-later
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
.. figure:: https://raw.githubusercontent.com/searxng/searxng/master/src/brand/searxng.svg
|
.. figure:: https://raw.githubusercontent.com/searxng/searxng/master/src/brand/searxng.svg
|
||||||
:target: https://docs.searxng.org/
|
:target: https://docs.searxng.org/
|
||||||
:alt: SearXNG
|
:alt: SearXNG
|
||||||
:width: 100%
|
:width: 100%
|
||||||
:align: center
|
:align: center
|
||||||
|
|
||||||
|
----
|
||||||
|
|
||||||
|
Privacy-respecting, hackable `metasearch engine`_
|
||||||
|
|
||||||
|
If you are looking for running instances, ready to use, then visit searx.space_.
|
||||||
|
Otherwise jump to the user_, admin_ and developer_ handbooks you will find on
|
||||||
|
our homepage_.
|
||||||
|
|
||||||
|SearXNG install|
|
|SearXNG install|
|
||||||
|SearXNG homepage|
|
|SearXNG homepage|
|
||||||
|SearXNG wiki|
|
|SearXNG wiki|
|
||||||
|
@ -15,12 +25,7 @@
|
||||||
|weblate|
|
|weblate|
|
||||||
|SearXNG logo|
|
|SearXNG logo|
|
||||||
|
|
||||||
Privacy-respecting, hackable `metasearch engine`_
|
----
|
||||||
|
|
||||||
If you are looking for running instances, ready to use, then visit searx.space_.
|
|
||||||
|
|
||||||
Otherwise jump to the user_, admin_ and developer_ handbooks you will find on
|
|
||||||
our homepage_.
|
|
||||||
|
|
||||||
.. _searx.space: https://searx.space
|
.. _searx.space: https://searx.space
|
||||||
.. _user: https://docs.searxng.org/user
|
.. _user: https://docs.searxng.org/user
|
||||||
|
@ -58,26 +63,76 @@ our homepage_.
|
||||||
:target: https://weblate.bubu1.eu/projects/searxng/
|
:target: https://weblate.bubu1.eu/projects/searxng/
|
||||||
|
|
||||||
|
|
||||||
SearXNG is a fork of `searx`_:
|
Contact
|
||||||
|
=======
|
||||||
|
|
||||||
* `the differences with searx <https://github.com/searxng/searxng/issues/46>`_
|
Come join us if you have questions or just want to chat about SearXNG.
|
||||||
* `exhaustive changelog <https://github.com/searxng/searxng/wiki/Changes-from-version-1.0.0>`_
|
|
||||||
|
Matrix
|
||||||
|
`#searxng:matrix.org <https://matrix.to/#/#searxng:matrix.org>`_
|
||||||
|
|
||||||
|
IRC
|
||||||
|
`#searxng on libera.chat <https://web.libera.chat/?channel=#searxng>`_
|
||||||
|
which is bridged to Matrix.
|
||||||
|
|
||||||
|
|
||||||
|
Differences to searx
|
||||||
|
====================
|
||||||
|
|
||||||
|
SearXNG is a fork of `searx`_. Here are some of the changes:
|
||||||
|
|
||||||
.. _searx: https://github.com/searx/searx
|
.. _searx: https://github.com/searx/searx
|
||||||
|
|
||||||
|
|
||||||
Contact
|
User experience
|
||||||
"""""""
|
---------------
|
||||||
|
|
||||||
Matrix: `#searxng:matrix.org <https://matrix.to/#/#searxng:matrix.org>`_
|
- Huge update of the simple theme:
|
||||||
|
|
||||||
|
* usable on desktop, tablet and mobile
|
||||||
|
* light and dark versions (you can choose in the preferences)
|
||||||
|
* support right-to-left languages
|
||||||
|
|
||||||
|
- the translations are up to date, you can contribute on `Weblate`_
|
||||||
|
- the preferences page has been updated:
|
||||||
|
|
||||||
|
* you can see which engines are reliable or not
|
||||||
|
* engines are grouped inside each tab
|
||||||
|
* each engine has a description
|
||||||
|
|
||||||
|
- it is easier to report a bug of an engine
|
||||||
|
- but you can also disable the recording of the metrics on the server
|
||||||
|
|
||||||
|
|
||||||
|
Setup
|
||||||
|
-----
|
||||||
|
|
||||||
|
- the Docker image is now also built for ARM64 and ARM/v7 architectures
|
||||||
|
- you don't need `Morty`_ to proxy the images even on a public instance
|
||||||
|
- on the way to embed `Filtron`_ into SearXNG
|
||||||
|
- up to date installation scripts
|
||||||
|
|
||||||
|
|
||||||
|
Contributing is easier
|
||||||
|
----------------------
|
||||||
|
|
||||||
|
- readable debug log
|
||||||
|
- contributions to the themes are made easier, check out our `Development
|
||||||
|
Quickstart`_ guide
|
||||||
|
- a lot of code cleanup and bug fixes
|
||||||
|
- the dependencies are up to date
|
||||||
|
|
||||||
|
.. _Morty: https://github.com/asciimoo/morty
|
||||||
|
.. _Filtron: https://github.com/searxng/filtron
|
||||||
|
.. _Weblate: https://weblate.bubu1.eu/projects/searxng/searxng/
|
||||||
|
.. _Development Quickstart: https://docs.searxng.org/dev/quickstart.html
|
||||||
|
|
||||||
IRC: `#searxng on libera.chat <https://web.libera.chat/?channel=#searxng>`_ which is bridged to Matrix.
|
|
||||||
|
|
||||||
|
|
||||||
Translations
|
Translations
|
||||||
""""""""""""
|
============
|
||||||
|
|
||||||
We need translators, suggestions are welcome at https://weblate.bubu1.eu/projects/searxng/searxng/
|
We need translators, suggestions are welcome at
|
||||||
|
https://weblate.bubu1.eu/projects/searxng/searxng/
|
||||||
|
|
||||||
.. figure:: https://weblate.bubu1.eu/widgets/searxng/-/multi-auto.svg
|
.. figure:: https://weblate.bubu1.eu/widgets/searxng/-/multi-auto.svg
|
||||||
:target: https://weblate.bubu1.eu/projects/searxng/
|
:target: https://weblate.bubu1.eu/projects/searxng/
|
||||||
|
|
Loading…
Reference in New Issue