Improved README, added basic CI CD

Author: Roeegg2

.github/workflows/ci.yaml

@@ -0,0 +1,63 @@
+name: CI
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main ]
+  schedule:
+    - cron: '0 0 * * *'  # Run nightly to catch regressions
+
+env:
+  CARGO_TERM_COLOR: always
+  RUST_BACKTRACE: 1
+
+# TODO: Add Clippy and mock Funderberker testing
+
+jobs:
+  check:
+    name: Check
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        crate: [macros, utils, kernel]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+      - uses: Swatinem/rust-cache@v2
+        with:
+          key: crate-${{ matrix.crate }}
+      - name: Check ${{ matrix.crate }}
+        run: cargo +nightly check --manifest-path="${{ matrix.crate }}/Cargo.toml" --verbose
+
+  unit_tests:
+    name: Unit Test Individual Crates
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        crate: [macros, utils]
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+      - uses: Swatinem/rust-cache@v2
+        with:
+          key: crate-${{ matrix.crate }}
+      - name: Test ${{ matrix.crate }}
+        run: cargo +nightly test --manifest-path="${{ matrix.crate }}/Cargo.toml" --verbose
+
+  docs:
+    name: Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: dtolnay/rust-toolchain@stable
+      - uses: Swatinem/rust-cache@v2
+      - name: Build docs
+        run: cargo +nightly doc --manifest-path=kernel/Cargo.toml --no-deps --all-features
+      - name: Deploy to GitHub Pages
+        if: github.ref == 'refs/heads/main'
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./target/doc
+

README.md

@@ -1,3 +1,13 @@
+
+<p align="center">
+  <img src="./logo-no-bg.png" alt="jason" />
+</p>
+
+[![GitHub stars](https://img.shields.io/github/stars/roeegg2/funderberker.svg)](https://github.com/roeegg2/funderberker/stargazers)
+[![License](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+![CI Status](https://img.shields.io/github/actions/workflow/status/roeegg2/funderberker/.github/workflows/ci.yml)
+
+
 # Funderberker
 
 Funderberker is a WIP type 1 VMM written in Rust, with a focus on customizability and performance. 
@@ -25,3 +35,4 @@ just help
 Contributions are more than welcome!
 
 Funderberker is still in its infancy, so there are many things to do.
+