From a9275f8eeaab8d61dd7d9df29b9218ed45d0e87a Mon Sep 17 00:00:00 2001
From: David Lynch <david.lynch@unimelb.edu.au>
Date: Tue, 21 Sep 2021 14:19:01 +1000
Subject: [PATCH] // Documentation

Added Git ignore and readme
---
 .gitignore |  1 +
 README.md  | 34 +++++++++++++++++++++++++++++++++-
 2 files changed, 34 insertions(+), 1 deletion(-)
 create mode 100644 .gitignore

diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000..997ca2f
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1 @@
+.vagrant
\ No newline at end of file
diff --git a/README.md b/README.md
index b0a08c2..7872eca 100644
--- a/README.md
+++ b/README.md
@@ -1 +1,33 @@
-Vagrant With Quartus
+# Vagrant With Quartus
+
+## Description
+
+This Vagrant image is used to generate a Ubuntu virtual machine with Quartus Prime Lite preinstalled.
+
+## Prerequisites
+
+Virtualbox: https://www.virtualbox.org/wiki/Downloads
+Vagrant: https://www.vagrantup.com/downloads
+
+Memory: 16GB or more recommended (if you have less see notes)
+Hard Drive Space: At least 20GB free space
+
+## Usage
+Simply run the respective run script for your operating system:
+
+Windows: 
+
+Linux: ./run.sh
+
+Mac:
+
+Note: This will likely take 1-2 hours (depending on your internet speed). 
+
+## Contribution
+
+Anyone is welcome to contribute to this project. To do so, clone the local repository to your local workspace, create a git feature branch and request a pull request. Upon review, the pull request will then be accepted or denied.
+
+
+## Author
+
+David Lynch
\ No newline at end of file
-- 
GitLab