From 21e1362e53244e06b3ff3ebca577dd099ff97eb7 Mon Sep 17 00:00:00 2001
From: Peter 201943 Mangelsdorf <pjm349@drexel.edu>
Date: Fri, 4 Mar 2022 19:58:09 -0500
Subject: [PATCH] Add Installation Guide; Update Contributing with Script
 Notice; Update README with INSTALL link

---
 CONTRIBUTING.md |  5 +++++
 INSTALL.md      | 56 +++++++++++++++++++++++++++++++++++++++++++++++++
 README.md       |  2 ++
 3 files changed, 63 insertions(+)
 create mode 100644 INSTALL.md

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index ce51302..12d6336 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -156,6 +156,11 @@ At the end of the day, we are guests to someone else's codebase.
 You should learn whatever guidelines they have have and follow them.
 This is not a lot of text, but the implications are big, you must study how the external group writes their code.
 
+One explicit requirement is to run some scripts before creating a pull request:
+- `./manage.py test` (runs the test suite)
+- `./manage.py lint` (runs the linter)
+- `./manage.py format` (applies automatic code formatting on Python files)
+
 Otherwise, we recommend taking the time to thoroughly *document* and *test* your code.
 [JavaDocs](https://en.wikipedia.org/wiki/Javadoc) and [Unit tests](https://en.wikipedia.org/wiki/Unit_testing) are a good place to start.
 
diff --git a/INSTALL.md b/INSTALL.md
new file mode 100644
index 0000000..dafa54e
--- /dev/null
+++ b/INSTALL.md
@@ -0,0 +1,56 @@
+
+# Installation
+
+## 1. [Download Git](https://git-scm.com/downloads)
+
+## 2. [Download Vagrant](https://www.vagrantup.com/downloads)
+
+## 3. [Download VirtualBox](https://www.virtualbox.org/wiki/Downloads) or an equivalent compatible Virtual Machine System
+
+## 4. Cleanup Line Endings (Windows Only)
+    
+Make sure you are in the `team-blue` directory and can see the `.git` directory before running this command.
+
+```bash
+git config core.autocrlf input
+```
+
+## 5. Launch Git Bash with Administrative Privileges (Windows Only) for any following commands
+
+## 6. Clone the Team Repo
+```bash
+git clone --recurse-submodules git@gitlab.cci.drexel.edu:courseeval/team-blue.git se420-team-blue
+```
+
+## 7. Navigate to the EvaP Directory
+```bash
+cd se420-team-blue
+cd EvaP
+```
+
+## 8. Activate Vagrant (and Apply Updates)
+```bash
+vagrant up
+```
+
+## 9. Activate Vagrant Connection
+```bash
+vagrant ssh
+```
+
+## 10. Launch the Server
+```bash
+./manage.py run
+```
+
+## 11. Access the Website  
+Open a browser to: http://localhost:8000/  
+login with:  
+```yaml
+email:    evap@institution.example.com
+password: evap
+```
+
+## NOTE
+[Read E-Valuation's README](https://github.com/e-valuation/EvaP/#installation) and [Installation Guide](https://github.com/e-valuation/EvaP/wiki/Installation) before beginning but ***DO NOT FOLLOW THEIR STEPS*** (Their steps download to a separate folder and will create problems later when you go to install).
+
diff --git a/README.md b/README.md
index 8aecb29..25e895f 100644
--- a/README.md
+++ b/README.md
@@ -35,6 +35,8 @@ Please join us on [Discord](https://discord.gg/QKBxxSS9), we are largely focused
 
 We currently do a lot of work in *Microsoft Word* and *Markdown*, so having a Microsoft account and a decent text editor is recommendable.
 
+For code-related portions of the project, please consult the [`INSTALL`](INSTALL.md) and the [e-valuation GitHub](https://github.com/e-valuation/EvaP/) for how to run the software.
+
 
 ## Roadmap
 (MISSING)
-- 
GitLab