From 298498e934db45d2f87668ffd2b0260073eb38f3 Mon Sep 17 00:00:00 2001 From: Charlie Marsh Date: Tue, 14 Feb 2023 19:25:07 -0500 Subject: [PATCH] Add an Acknowledgements section to the README (#2907) --- README.md | 25 +++++++++++++++++++++++++ scripts/generate_mkdocs.py | 1 + 2 files changed, 26 insertions(+) diff --git a/README.md b/README.md index 4ec9f77695..c0d4c482ee 100644 --- a/README.md +++ b/README.md @@ -169,6 +169,7 @@ This README is also available as [documentation](https://beta.ruff.rs/docs/). 1. [Contributing](#contributing) 1. [Support](#support) 1. [Reference](#reference) +1. [Acknowledgements](#acknowledgements) 1. [License](#license) ## Installation and Usage @@ -4036,6 +4037,30 @@ keep-runtime-typing = true + + +## Acknowledgements + +Ruff's linter draws on both the APIs and implementation details of many other +tools in the Python ecosystem, especially [Flake8](https://github.com/PyCQA/flake8), [Pyflakes](https://github.com/PyCQA/pyflakes), +[pycodestyle](https://github.com/PyCQA/pycodestyle), [pydocstyle](https://github.com/PyCQA/pydocstyle), +[pyupgrade](https://github.com/asottile/pyupgrade), and [isort](https://github.com/PyCQA/isort). + +In some cases, Ruff includes a "direct" Rust port of the corresponding tool. +We're grateful to the maintainers of these tools for their work, and for all +the value they've provided to the Python community. + +Ruff's autoformatter is built on a fork of Rome's [`rome_formatter`](https://github.com/rome/tools/tree/main/crates/rome_formatter), +and again draws on both the APIs and implementation details of [Rome](https://github.com/rome/tools), +[Prettier](https://github.com/prettier/prettier), and [Black](https://github.com/psf/black). + +Ruff is also influenced by a number of tools outside the Python ecosystem, like +[Clippy](https://github.com/rust-lang/rust-clippy) and [ESLint](https://github.com/eslint/eslint). + +Ruff is released under the MIT license. + + + ## License MIT diff --git a/scripts/generate_mkdocs.py b/scripts/generate_mkdocs.py index e47dd0cff1..c8fcda36a4 100644 --- a/scripts/generate_mkdocs.py +++ b/scripts/generate_mkdocs.py @@ -14,6 +14,7 @@ SECTIONS: list[tuple[str, str]] = [ ("Settings", "settings.md"), ("Editor Integrations", "editor-integrations.md"), ("FAQ", "faq.md"), + ("Acknowledgements", "acknowledgements.md"), ] DOCUMENTATION_LINK: str = (