Add Readme

Author: MinerSebas

.github/workflows/ci.yml

@@ -92,7 +92,7 @@ jobs:
         run: cargo install cargo-dylint; cargo install dylint-link
         if: steps.cache.outputs.cache-hit != 'true'
       - name: Run dylint
-        run: cargo dylint --all --workspace
+        run: cargo dylint --all --workspace -- --all-targets
       - name: Check Format
         run: cd crates/bevy_lint; cargo fmt --all -- --check
       - name: Check Clippy

crates/bevy_lint/Cargo.toml

@@ -2,7 +2,7 @@
 name = "bevy_lint"
 version = "0.1.0"
 authors = ["Bevy Contributors <[email protected]>"]
-description = "decription goes here"
+description = "Provides Lints for Bevy Code"
 edition = "2018"
 publish = false
 

crates/bevy_lint/readme.md

@@ -0,0 +1,34 @@
+# Bevy Lint
+
+## What is Bevy Lint?
+
+This crates provides Lints for Bevy Code using [dylint](https://github.com/trailofbits/dylint).
+
+## How to you run Lints
+
+Add this to your Cargo.toml:
+
+```toml
+[workspace.metadata.dylint]
+libraries = [
+    { git = "https://github.com/bevyengine/bevy", tag = "v0.6.0", pattern = "crates/bevy_dylint" },
+]
+```
+
+Instead of a `tag`, you can also provide a `branch` or a `rev` (revision).
+
+Afterwards you need to run these commans:
+
+```sh
+cargo install cargo-dylint dylint-link    # Only neccesary once
+cargo dylint bevy_dylint
+```
+
+## Lint Creation
+
+A Lint is created by implementing the [LateLintPass](https://doc.rust-lang.org/stable/nightly-rustc/rustc_lint/trait.LateLintPass.html) trait and adding to the `register_lints` function.
+
+When creating a UI Test, add the Test as an Example to the [Cargo.toml](Cargo.toml).
+Also make sure that your `.stderr` File uses `LF` Line-endings and not `CRLF`, as otherwise the Test will fail without any explanation.
+
+For more Resources you can take a look at the [dylint resources](https://github.com/trailofbits/dylint#resources).

crates/bevy_lint/src/unnecessary_with.rs

@@ -12,8 +12,9 @@ use crate::bevy_paths;
 
 declare_lint! {
     /// **What it does:**
-    /// Detectes unnecessary instances of the `With`
+    /// Detects unnecessary `With` query filters in Bevy query parameters.
     /// **Why is this bad?**
+    /// The Filter does not effect the Results of a query, but still wasted space.
     ///
     /// **Known problems:** None.
     ///