ci: wip - generate readme

Author: ckrenslehner

.github/workflows/rust.yml

@@ -5,40 +5,51 @@ env:
   CLICOLOR: 1
 
 jobs:
-  spelling:
-    name: Spell Check with Typos
-    runs-on: ubuntu-latest
-    steps:
-    - name: Checkout Actions Repository
-      uses: actions/checkout@v4
-    - name: Spell Check Repo
-      uses: crate-ci/[email protected]
-      
-  clippy:
-    name: clippy
+  readme:
+    name: Generate Readme
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
       - uses: dtolnay/rust-toolchain@stable
-      - run: cargo clippy -- -D warnings
+      - run: cargo install cargo-readme
+      - run: cargo-readme --help
+      
+# jobs:
+#   spelling:
+#     name: Spell Check with Typos
+#     runs-on: ubuntu-latest
+#     steps:
+#     - name: Checkout Actions Repository
+#       uses: actions/checkout@v4
+#     - name: Spell Check Repo
+#       uses: crate-ci/[email protected]
+      
+#   clippy:
+#     name: clippy
+#     runs-on: ubuntu-latest
+#     steps:
+#       - uses: actions/checkout@v4
+#       - uses: dtolnay/rust-toolchain@stable
+#       - run: cargo clippy -- -D warnings
 
-  format:
-    name: format
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: dtolnay/rust-toolchain@stable
-      - run: cargo fmt -- --check
+#   format:
+#     name: format
+#     runs-on: ubuntu-latest
+#     steps:
+#       - uses: actions/checkout@v4
+#       - uses: dtolnay/rust-toolchain@stable
+#       - run: cargo fmt -- --check
 
-  test_and_build:
-    strategy:
-      matrix:
-        os: [ubuntu-latest, windows-latest]
+#   test_and_build:
+#     strategy:
+#       fail-fast: false
+#       matrix:
+#         os: [ubuntu-latest, windows-latest]
 
-    name: test_and_build
-    runs-on: ${{ matrix.os }}
-    steps:
-      - uses: actions/checkout@v4
-      - uses: dtolnay/rust-toolchain@stable
-      - run: cargo test --release
-      - run: cargo b --release
+#     name: test_and_build
+#     runs-on: ${{ matrix.os }}
+#     steps:
+#       - uses: actions/checkout@v4
+#       - uses: dtolnay/rust-toolchain@stable
+#       - run: cargo test --release
+#       - run: cargo b --release