Improved README, added basic CI CD

Author: Roeegg2

.github/workflows/ci.yaml

@@ -0,0 +1,68 @@
+name: CI
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main ]
+  schedule:
+    # Run nightly to catch regressions
+    - cron: '0 0 * * *'
+
+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
+  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 doc --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,11 @@
+
+![jason](./logo-no-bg.png)
+
+[![GitHub stars](https://img.shields.io/github/stars/username/repo-name.svg)](https://github.com/username/repo-name/stargazers)
+[![License](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
+![Stars](https://img.shields.io/github/stars/roeegg2/funderberker)
+
+
 # Funderberker
 
 Funderberker is a WIP type 1 VMM written in Rust, with a focus on customizability and performance. 
@@ -25,3 +33,4 @@ just help
 Contributions are more than welcome!
 
 Funderberker is still in its infancy, so there are many things to do.
+