Skip to content

Commit

Permalink
docs: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Hqnnqh committed Jan 12, 2025
1 parent 22741c8 commit 401083d
Showing 1 changed file with 36 additions and 0 deletions.
36 changes: 36 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1 +1,37 @@
# nebula os

A x86-64 hobby operating system written entirely from scratch in Rust.

## Getting Started

### Prerequisites
- A computer or virtual machine with UEFI support.
- A Rust toolchain installed via [rustup](https://rustup.rs/).
- QEMU (for testing)

### Cloning the Repository

Clone the repository to your local machine:

```bash
git clone https://github.com/nebulafoundation/nebula-os.git
cd nebula-os
```

### Running

#### QEMU

```bash
make run release=true
```

#### Real Machine

```bash
make usb USB_DEVICE=/dev/<device> release=true
```

> Makefile will later be replaced by proper boot utility

0 comments on commit 401083d

Please sign in to comment.