-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
36 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|