searxngRebrandZaclys/README.rst

.. SPDX-License-Identifier: AGPL-3.0-or-later

----

.. figure:: https://raw.githubusercontent.com/searxng/searxng/master/src/brand/searxng.svg
   :target: https://docs.searxng.org/
   :alt: SearXNG
   :width: 100%
   :align: center

----

Privacy-respecting, hackable `metasearch engine`_

Searx.space_ lists ready-to-use running instances.

A user_, admin_ and developer_ handbook is available on the homepage_.

|SearXNG install|
|SearXNG homepage|
|SearXNG wiki|
|AGPL License|
|Issues|
|commits|
|weblate|
|SearXNG logo|

----

.. _searx.space: https://searx.space
.. _user: https://docs.searxng.org/user
.. _admin: https://docs.searxng.org/admin
.. _developer: https://docs.searxng.org/dev
.. _homepage: https://docs.searxng.org/
.. _metasearch engine: https://en.wikipedia.org/wiki/Metasearch_engine

.. |SearXNG logo| image:: https://raw.githubusercontent.com/searxng/searxng/master/src/brand/searxng-wordmark.svg
   :target: https://docs.searxng.org/
   :width: 5%

.. |SearXNG install| image:: https://img.shields.io/badge/-install-blue
   :target: https://docs.searxng.org/admin/installation.html

.. |SearXNG homepage| image:: https://img.shields.io/badge/-homepage-blue
   :target: https://docs.searxng.org/

.. |SearXNG wiki| image:: https://img.shields.io/badge/-wiki-blue
   :target: https://github.com/searxng/searxng/wiki

.. |AGPL License|  image:: https://img.shields.io/badge/license-AGPL-blue.svg
   :target: https://github.com/searxng/searxng/blob/master/LICENSE

.. |Issues| image:: https://img.shields.io/github/issues/searxng/searxng?color=yellow&label=issues
   :target: https://github.com/searxng/searxng/issues

.. |PR| image:: https://img.shields.io/github/issues-pr-raw/searxng/searxng?color=yellow&label=PR
   :target: https://github.com/searxng/searxng/pulls

.. |commits| image:: https://img.shields.io/github/commit-activity/y/searxng/searxng?color=yellow&label=commits
   :target: https://github.com/searxng/searxng/commits/master

.. |weblate| image:: https://translate.codeberg.org/widgets/searxng/-/searxng/svg-badge.svg
   :target: https://translate.codeberg.org/projects/searxng/


Contact
=======

Ask questions or just chat about SearXNG on

IRC
  `#searxng on libera.chat <https://web.libera.chat/?channel=#searxng>`_
  which is bridged to Matrix.

Matrix
  `#searxng:matrix.org <https://matrix.to/#/#searxng:matrix.org>`_

Differences to searXNG
====================

SearXNGRebrandZaclys is a fork of `searXNG`_, with non-notable changes:

.. _searXNG: https://github.com/searxng/searxng


Simply graphic changes (icons and images) and addition of the Zaclys menu
[README] update and polish up a little by using badges about markup & badges - https://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rst - https://github.com/Naereen/badges/blob/master/README.rst - https://shields.io/ - https://gist.github.com/tterb/982ae14a9307b80117dbf49f624ce0e8 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> 2020-05-12 12:57:45 +00:00			`.. SPDX-License-Identifier: AGPL-3.0-or-later`

[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> 2022-01-15 15:47:25 +00:00			`----`

[mod] themes/simple/img/searxng.svg -> src/brand/searxng.svg * move `searx/static/themes/simple/img/searxng.svg` to `src/brand/searxng.svg` * README.rst can use it without a reference to a theme. * the simple theme can create `searx/static/themes/simple/img/searxng.png` using the svg2png task Suggested-by: @dalf https://github.com/searxng/searxng/pull/561#issuecomment-981747902 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> 2021-11-29 18:38:23 +00:00			`.. figure:: https://raw.githubusercontent.com/searxng/searxng/master/src/brand/searxng.svg`
reference docs.searxng.org 2022-01-02 19:54:41 +00:00			`:target: https://docs.searxng.org/`
[brand] README: add SearXNG logo Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> 2021-11-29 12:26:31 +00:00			`:alt: SearXNG`
			`:width: 100%`
			`:align: center`
[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> 2022-01-15 15:47:25 +00:00
			`----`

			Privacy-respecting, hackable `metasearch engine`_

[readme] reworked / partial merge of #2200 Related: - https://github.com/searxng/searxng/pull/2203 - https://github.com/searxng/searxng/pull/2200#issuecomment-1434594489 Closes: https://github.com/searxng/searxng/pull/2200 2023-02-17 10:01:15 +00:00			`Searx.space_ lists ready-to-use running instances.`

			`A user_, admin_ and developer_ handbook is available on the homepage_.`
[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> 2022-01-15 15:47:25 +00:00
[brand] README: add SearXNG logo Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> 2021-11-29 12:26:31 +00:00			`\|SearXNG install\|`
			`\|SearXNG homepage\|`
			`\|SearXNG wiki\|`
[README] update and polish up a little by using badges about markup & badges - https://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rst - https://github.com/Naereen/badges/blob/master/README.rst - https://shields.io/ - https://gist.github.com/tterb/982ae14a9307b80117dbf49f624ce0e8 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> 2020-05-12 12:57:45 +00:00			`\|AGPL License\|`
			`\|Issues\|`
			`\|commits\|`
README.rst : add weblate link 2021-08-17 08:58:26 +00:00			`\|weblate\|`
[brand] README: add SearXNG logo Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> 2021-11-29 12:26:31 +00:00			`\|SearXNG logo\|`
[mod] README format change - pypi compatiblity 2014-01-21 19:47:43 +00:00
[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> 2022-01-15 15:47:25 +00:00			`----`
[brand] README: add SearXNG logo Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> 2021-11-29 12:26:31 +00:00
			`.. _searx.space: https://searx.space`
reference docs.searxng.org 2022-01-02 19:54:41 +00:00			`.. _user: https://docs.searxng.org/user`
[fix] url 2022-01-23 01:55:17 +00:00			`.. _admin: https://docs.searxng.org/admin`
reference docs.searxng.org 2022-01-02 19:54:41 +00:00			`.. _developer: https://docs.searxng.org/dev`
			`.. _homepage: https://docs.searxng.org/`
[README] update and polish up a little by using badges about markup & badges - https://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rst - https://github.com/Naereen/badges/blob/master/README.rst - https://shields.io/ - https://gist.github.com/tterb/982ae14a9307b80117dbf49f624ce0e8 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> 2020-05-12 12:57:45 +00:00			`.. _metasearch engine: https://en.wikipedia.org/wiki/Metasearch_engine`
[mod] README format change - pypi compatiblity 2014-01-21 19:47:43 +00:00
[brand] README: add SearXNG logo Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> 2021-11-29 12:26:31 +00:00			`.. \|SearXNG logo\| image:: https://raw.githubusercontent.com/searxng/searxng/master/src/brand/searxng-wordmark.svg`
reference docs.searxng.org 2022-01-02 19:54:41 +00:00			`:target: https://docs.searxng.org/`
[brand] README: add SearXNG logo Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> 2021-11-29 12:26:31 +00:00			`:width: 5%`

			`.. \|SearXNG install\| image:: https://img.shields.io/badge/-install-blue`
reference docs.searxng.org 2022-01-02 19:54:41 +00:00			`:target: https://docs.searxng.org/admin/installation.html`
[mod] README format change - pypi compatiblity 2014-01-21 19:47:43 +00:00
[brand] README: add SearXNG logo Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> 2021-11-29 12:26:31 +00:00			`.. \|SearXNG homepage\| image:: https://img.shields.io/badge/-homepage-blue`
reference docs.searxng.org 2022-01-02 19:54:41 +00:00			`:target: https://docs.searxng.org/`
[mod] README format change - pypi compatiblity 2014-01-21 19:47:43 +00:00
[brand] README: add SearXNG logo Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> 2021-11-29 12:26:31 +00:00			`.. \|SearXNG wiki\| image:: https://img.shields.io/badge/-wiki-blue`
searxng brand 2021-04-22 06:33:31 +00:00			`:target: https://github.com/searxng/searxng/wiki`
[mod] README format change - pypi compatiblity 2014-01-21 19:47:43 +00:00
[README] update and polish up a little by using badges about markup & badges - https://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rst - https://github.com/Naereen/badges/blob/master/README.rst - https://shields.io/ - https://gist.github.com/tterb/982ae14a9307b80117dbf49f624ce0e8 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> 2020-05-12 12:57:45 +00:00			`.. \|AGPL License\| image:: https://img.shields.io/badge/license-AGPL-blue.svg`
[brand] README.rst fix img.shields.io and searxng.github.io URLs Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> 2021-04-26 13:47:56 +00:00			`:target: https://github.com/searxng/searxng/blob/master/LICENSE`
[mod] README format change - pypi compatiblity 2014-01-21 19:47:43 +00:00
[brand] README.rst fix img.shields.io and searxng.github.io URLs Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> 2021-04-26 13:47:56 +00:00			`.. \|Issues\| image:: https://img.shields.io/github/issues/searxng/searxng?color=yellow&label=issues`
searxng brand 2021-04-22 06:33:31 +00:00			`:target: https://github.com/searxng/searxng/issues`
[mod] README format change - pypi compatiblity 2014-01-21 19:47:43 +00:00
[brand] README.rst fix img.shields.io and searxng.github.io URLs Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> 2021-04-26 13:47:56 +00:00			`.. \|PR\| image:: https://img.shields.io/github/issues-pr-raw/searxng/searxng?color=yellow&label=PR`
searxng brand 2021-04-22 06:33:31 +00:00			`:target: https://github.com/searxng/searxng/pulls`
[mod] README format change - pypi compatiblity 2014-01-21 19:47:43 +00:00
[brand] README.rst fix img.shields.io and searxng.github.io URLs Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> 2021-04-26 13:47:56 +00:00			`.. \|commits\| image:: https://img.shields.io/github/commit-activity/y/searxng/searxng?color=yellow&label=commits`
searxng brand 2021-04-22 06:33:31 +00:00			`:target: https://github.com/searxng/searxng/commits/master`
[README] update and polish up a little by using badges about markup & badges - https://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rst - https://github.com/Naereen/badges/blob/master/README.rst - https://shields.io/ - https://gist.github.com/tterb/982ae14a9307b80117dbf49f624ce0e8 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> 2020-05-12 12:57:45 +00:00
weblate: migration to https://translate.codeberg.org/ 2023-01-21 14:49:46 +00:00			`.. \|weblate\| image:: https://translate.codeberg.org/widgets/searxng/-/searxng/svg-badge.svg`
			`:target: https://translate.codeberg.org/projects/searxng/`
[README] update and polish up a little by using badges about markup & badges - https://github.com/ralsina/rst-cheatsheet/blob/master/rst-cheatsheet.rst - https://github.com/Naereen/badges/blob/master/README.rst - https://shields.io/ - https://gist.github.com/tterb/982ae14a9307b80117dbf49f624ce0e8 Signed-off-by: Markus Heiser <markus.heiser@darmarit.de> 2020-05-12 12:57:45 +00:00

[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> 2022-01-15 15:47:25 +00:00			`Contact`
			`=======`

[readme] reworked / partial merge of #2200 Related: - https://github.com/searxng/searxng/pull/2203 - https://github.com/searxng/searxng/pull/2200#issuecomment-1434594489 Closes: https://github.com/searxng/searxng/pull/2200 2023-02-17 10:01:15 +00:00			`Ask questions or just chat about SearXNG on`
[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> 2022-01-15 15:47:25 +00:00
			`IRC`
			`#searxng on libera.chat <https://web.libera.chat/?channel=#searxng>`_
			`which is bridged to Matrix.`

[readme] reworked / partial merge of #2200 Related: - https://github.com/searxng/searxng/pull/2203 - https://github.com/searxng/searxng/pull/2200#issuecomment-1434594489 Closes: https://github.com/searxng/searxng/pull/2200 2023-02-17 10:01:15 +00:00			`Matrix`
			`#searxng:matrix.org <https://matrix.to/#/#searxng:matrix.org>`_
[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> 2022-01-15 15:47:25 +00:00
rebrand add zaclys menu adjust style 2023-08-28 07:52:05 +00:00			`Differences to 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> 2022-01-15 15:47:25 +00:00			`====================`

rebrand add zaclys menu adjust style 2023-08-28 07:52:05 +00:00			SearXNGRebrandZaclys is a fork of `searXNG`_, with non-notable changes:
README.rst: differences with searx 2021-09-03 14:37:11 +00:00
rebrand add zaclys menu adjust style 2023-08-28 07:52:05 +00:00			`.. _searXNG: https://github.com/searxng/searxng`
README.rst: add translation status Related to https://github.com/searxng/searxng/issues/540 2021-11-30 23:08:44 +00:00
README.rst: add contact information 2021-12-14 20:53:06 +00:00
rebrand add zaclys menu adjust style 2023-08-28 07:52:05 +00:00			`Simply graphic changes (icons and images) and addition of the Zaclys menu`