aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 7e44da6be1148f6b116e20fabd199579b7f7af13 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
[![Review Assignment Due Date](https://classroom.github.com/assets/deadline-readme-button-24ddc0f5d75046c5622901739e7c5dd533143b0c8e959d652212380cedb1ea36.svg)](https://classroom.github.com/a/xSREhkGA)
# 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`.