From c63f340d90800895f007de64b7d2d14624263331 Mon Sep 17 00:00:00 2001
From: nthnluu <nate1299@me.com>
Date: Sun, 28 Jan 2024 21:20:27 -0500
Subject: Created student weenix repository

---
 README.md | 39 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 39 insertions(+)
 create mode 100644 README.md

(limited to 'README.md')

diff --git a/README.md b/README.md
new file mode 100644
index 0000000..f0127ba
--- /dev/null
+++ b/README.md
@@ -0,0 +1,39 @@
+# Installation
+
+This file contains quick instructions for getting Weenix to run on
+Redhat-derived or Debian-derived Linux flavors. If you're using a virtual machine with the Weenix Vagrantfile, the dependencies should be installed automatically when the machine is provisioned.
+
+See also [Getting Started with Weenix](https://github.com/brown-cs1690/handout/wiki/Getting-Started-with-Weenix) for more thorough documentation.
+
+1. Download and install dependencies.
+
+   On recent versions of Ubuntu or Debian, you can simply run:
+
+   ```bash
+   $ sudo apt-get install git-core build-essential gcc gdb qemu genisoimage make python python-argparse cscope xterm bash grub xorriso
+   ```
+
+   or on Redhat:
+
+   ```bash
+   $ sudo yum install git-core gcc gdb qemu genisoimage make python python-argparse cscope xterm bash grub2-tools xorriso
+   ```
+
+2. Compile Weenix:
+
+   ```bash
+   $ make
+   ```
+
+3. Invoke Weenix:
+
+   ```bash
+   $ ./weenix -n
+   ```
+
+   or, to run Weenix under gdb, run:
+
+   ```bash
+   $ ./weenix -n -d gdb
+   ```
+   You may also need to install `pyelftools`, to do so, make sure that you have pip3 installed. Once you have that installed, you can run `pip3 install pyelftools`. 
\ No newline at end of file
-- 
cgit v1.2.3-70-g09d2