diff --git a/README.md b/README.md index d69a83d..85acf64 100644 --- a/README.md +++ b/README.md @@ -9,15 +9,17 @@ in not actively maintained projects. Note: ruleset syntax is not final. -``` -% cat omnilinter.conf +### Example ruleset + +```yaml rules: - title: convert deprecated auto_ptr to unique_ptr files: "*.cpp" match: auto_ptr -- title: convert setup.py to pyptoject.toml +- title: convert setup.py to pyproject.toml files: setup.py + nofiles: pyproject.toml - title: change indentation to spaces files: "*.py" @@ -30,7 +32,19 @@ rules: - title: add README.md nofiles: README.md +``` + +See also [config](.omnilinter.conf) used to check omnilinter's own codebase. + +### Example output + +Command: +``` % omnilinter -c omnilinter.conf projects/* +``` + +Output: +``` projects/my_python_project: - setup.py: convert setup.py to pyptoject.toml - src/__init__.py: add license information @@ -43,3 +57,19 @@ project/my_cpp_lib: - src/main.cpp:17: convert deprecated auto_ptr to unique_ptr - src/main.cpp:49: convert deprecated auto_ptr to unique_ptr ``` + +## Ruleset format + +TODO + +## Arguments + +TODO + +## Author + +* [Dmitry Marakasov](https://github.com/AMDmi3) + +## License + +* [GPL-3.0-or-later](LICENSE)