Update README.md

Author: KohmeiK

README.md

@@ -1 +1,94 @@
-Gradle Build Status on main: ![.github/workflows/test.yml](https://github.com/CS3733-C21-Team-U/CS3733-C21-Team-U-Project-BWApp/workflows/.github/workflows/test.yml/badge.svg)
+<!-- ABOUT THE PROJECT -->
+[![Product Name Screen Shot][product-screenshot]](https://youtu.be/84nr0pFNmIE)
+
+This Application for Brigham and Women’s Hospital was developed to assist hospital
+employees and administrators with their daily tasks, as well as train students in the WPI CS
+3733 Software Engineering class. Agile methodology was used during the development,
+where the team focused on the need of the users to prioritize tasks and organize the design
+process.
+
+### Main Features
+* Robust, automated, multiplatform, Handling of COVID-19 risk before allowing users to enter the campus.
+* Advanced and customizable service request management, creation, and delegation.
+* Simple to use pathfinding navigation system.
+* Map editing portal allowing full control of function of pathfinding system.
+* User account management functionality that is integrated within every system in the app.
+* Several different application experiences and functions depending on type of user account.
+* Mobile implementation of Pathfinding feature that is integrated into the COVID-19 facility admittance risk feature.
+
+**Watch a video of our [final presentation](https://youtu.be/84nr0pFNmIE) on Youtube**
+
+**See more [screenshots](https://drive.google.com/drive/folders/1IVsE6aBYgut-1ja_xGQBNLKaQGX4bQh1?usp=sharing) of our app**
+
+**Download our [final submission doc](https://docs.google.com/document/d/1isP2y5EyYgsyj1HRhtxLBZyQ3JKt5DbxevlvPPygO1I/edit?usp=sharing) which contains information on our Scrum process**
+
+### Built With
+
+* IntelliJ IDEA Utimate
+* Apache Derby
+* JavaFX
+* Gluon Scenebuilder
+* Twillio
+* JFeonix
+* Google Maps API
+* Adobe XD
+
+
+<!-- GETTING STARTED -->
+## Getting Started
+
+You can download a pre-compiled JAR file to run as a demo or clone the project if you would like to edit it.
+
+### Download Compiled Program
+Make sure you have [Java 8](https://www.oracle.com/technetwork/java/javase/downloads/index.html) installed! **This program does not run on any new versions of Java.**
+
+1. Download and unzip this folder: [Download JAR](https://drive.google.com/file/d/1WHYaf3kWZZlwsQCP4EVbTBOdXofKgJuf/view?usp=sharing)
+2. Double click the file ```CS3733-C21-Team-U-Project-BWApp.jar```
+3. If this does not work, run this command in your command line
+   ```sh
+   java -jar /Path/To/Downloaded/Folder/CS3733-C21-Team-U-Project-BWApp.jar
+   ```
+
+### Download and Run the Source Code
+
+1. Install [Java SE Development Kit 8u281 (Java SE JDK 8)](https://www.oracle.com/technetwork/java/javase/downloads/index.html)
+2. Install [Gluon Scene Builder 8.5.0 for Java 8](https://gluonhq.com/products/scene-builder/)
+3. Install [Apache Derby 10.14.2.0 for Java 8](https://db.apache.org/derby/derby_downloads.html#For+Java+8+and+Higher) 
+Download the bin distribution – the first link ending in .zip. Then double-click on the zip file.
+4. Clone this repo
+   ```sh
+   git clone https://github.com/Kohmei358/BrighamWomens-Hospital-App
+   ```
+3. Install Depencies Using Gradle
+   ```sh
+   gradle build
+   ```
+4. Run the ```main.java``` or ```App.java``` file inside ```/src/main/java/edu/wpi/u/```
+
+
+
+<!-- USAGE EXAMPLES -->
+## Usage
+
+_For detailed instructions, please refer to the [User Manual](https://docs.google.com/document/d/1gUSwUJI3Mz1sdK1vI5OzYh0ZP3KuNdfVIq-Mwi4Yq8E/edit?usp=sharing)_
+
+
+<!-- ACKNOWLEDGEMENTS -->
+## Acknowledgements
+* Proffessor **Wilson Wong** for creating an amazing course that changed so many of us
+* Brigham and Women's Faulkner Hospital and **Andrew Shinn** for their time and input
+* **Andrew Bonaventura** for beeing an amazing TA and for being aviable whenever we needed him
+* **Kohmei K.**	Lead Software Engineer [@Kohmei358](https://github.com/Kohmei358)
+* **Neville I.**	Asst. Lead Software Engineer [@beast-nev](https://github.com/beast-nev)
+* **Kaamil L.**	Asst. Lead Software Engineer [@kslokhandwala2022](https://github.com/kslokhandwala2022)
+* **Charles K.**	Asst. Lead Software Engineer [@cvkittler](https://github.com/cvkittler)
+* **William B.**	Back-End Database Engineer [@wgburke310](https://github.com/wgburke310)
+* **Olajumoke I.**	Back-End Database Engineer	[@olajac](https://github.com/olajac)
+* **Michael G.**	Algorithm Specialist	[@gearymich](https://github.com/gearymich)
+* **Jacob B.**	Project Manager	[@jBernardRobotics](https://github.com/jBernardRobotics)
+* **Tianyang G**.	Scrum Master [@nicklesscs](https://github.com/nicklesscs)
+* **Tyler S.**	Product Owner	[@tsanderv](https://github.com/tsanderv)
+* **Lily D.**	Documentation Analyst	[@LilyDurkin](https://github.com/LilyDurkin)
+
+
+[product-screenshot]: BWHeathFinalPoster.jpg