From c6fd82f1fb2a49d317bf161772901e7be5b3d951 Mon Sep 17 00:00:00 2001 From: Christian Evans Date: Tue, 26 Sep 2017 22:26:54 -0400 Subject: [PATCH] Update README.md Changed readme to provide small description and give installation instruction --- README.md | 37 ++++++++++++++++++++++++++++++++++--- 1 file changed, 34 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9114f2f..8bdf8e8 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,35 @@ -# Vis -A 3D/2D WYSIWYG Visualizer to aid CEESIM operations +# Vis - Web Visualizer +A 3D WYSIWYG Visualizer to aid Northrop Grumman CEESIM operations -Team: Nitin Garg, Christian Evans, David Lohle, and Joshua Waney +--- + +## What Is It? +Our program is an extension of the three.js development evironment modified to align with Northrop Grumman's Combat Magnetic Environment Simulator (CEESIM). Using this program you will be able to add, remove, and manipulate various antenna placements on a 3D aircraft model to simulate a realistic arrangment one might encounter in the field. + +--- + +## How To Run +Vis will run on any platform to include Windows, Mac OS, Linux, Android, and iOS devices. The only requirement is that you must be running a WebGL compatible browser. The following are supported: + - Google Chrome + - Mozilla Firefox + - Microsoft Internet Explorer + - Microsoft Edge + - Apple Safari + - Opera + - iOS Safari + - Android Browser + - Chrome for Android + +To begin, download the ZIP file located at the repository homepage under the "Clone or download" tab. + +From here you can extract the files to a location of your choosing. + +Open up the file location and navigate to the "editor" folder. + +Here you will see an html file entitled "Vis". + +Double-click the file to open the application in your internet browser. + +--- + +*Team: Nitin Garg, Christian Evans, David Lohle, and Joshua Waney*