Skip to content

Commit 5fba734

Browse files
committed
docs: added QUICKSTART.md for reproducible setup and demo for review and audits
1 parent 183fe24 commit 5fba734

1 file changed

Lines changed: 50 additions & 0 deletions

File tree

QUICKSTART.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# Axiom OS — Quick Start Guide
2+
3+
## Prerequisites
4+
5+
```bash
6+
# Install Rust nightly
7+
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
8+
rustup toolchain install nightly
9+
rustup override set nightly
10+
11+
# Install bootimage
12+
cargo install bootimage
13+
14+
# Install QEMU
15+
sudo apt install qemu-system-x86 qemu-system-arm
16+
17+
# Install ARM64 cross tools (for ARM build only)
18+
sudo apt install binutils-aarch64-linux-gnu
19+
```
20+
21+
## Boot x86_64
22+
23+
```bash
24+
git clone https://github.com/abhiprd2000/axiom-os-kernel.git
25+
cd axiom-os-kernel
26+
cargo run --bin axiom_os
27+
```
28+
29+
Expected output: AXIOM OS v0.2.0-alpha banner with shell prompt.
30+
31+
## Boot ARM64
32+
33+
```bash
34+
./run_arm.sh
35+
```
36+
37+
Expected output: AXIOM OS v0.2.0-alpha - aarch64, BLAKE3 hash, benchmark results.
38+
39+
## Run Benchmarks
40+
41+
Inside the x86_64 shell:
42+
bench
43+
44+
## Demo: Tamper Detection
45+
trust secret hello world
46+
cat secret
47+
tamper secret
48+
cat secret
49+
50+
Last command shows: READ BLOCKED — provenance violation

0 commit comments

Comments
 (0)