Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Linux build and run instructions, with system requirements #63

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 39 additions & 1 deletion INSTALL-xv6.md
Original file line number Diff line number Diff line change
Expand Up @@ -135,4 +135,42 @@ Now, time to go do the projects!

## Linux

TBD.
### Supported Linux Machines:
These instructions are tested on the following Linux distribution:
* Kubuntu - 24.04.1 LTS (Noble Numbat)

Note: These instructions require a 64-bit architecture. You must be running a 64-bit version of a supported Ubuntu/Debian distribution.

### Prerequisites
Install the necessary dependencies:

```bash
$ sudo apt update
$ sudo apt install build-essential qemu qemu-system-x86 gcc gdb git
```

Clone the Xv6 repository:
```bash
---
$ git clone [email protected]:mit-pdos/xv6-public.git
$ cd xv6-public
```
Build the Xv6 kernel:
```bash
$ make
```
Note: If you encounter errors related to warnings being treated as errors (due to the -Werror flag in the Makefile), you can disable this by removing the -Werror flag:
1. Open the Makefile.
2. Find the line that includes `-Werror`.
3. Remove or comment out the -Werror option.
This will allow the build to continue, even if there are warnings.

To run Xv6 in QEMU (with GUI):
```bash
$ make qemu
```

To run Xv6 without a GUI:
```bash
$ make qemu-nox
```