Create README.md

README.md

@@ -0,0 +1,35 @@
+banwebplus
+==========
+
+Make personal class scheduling simpler.
+
+## Example use
+The project is currently in use at https://banwebplus.com.
+
+## Why?
+This project was originally conceived to help [New Mexico Tech](http://www.nmt.edu/) students create a user schedule.
+The school's [existing website](https://banweb7.nmt.edu/pls/PROD/hwzkcrof.p_uncgslctcrsoff) is awful to use. Putting together
+classes for a schedule was a painstaking process that often took 2-3 hours every semester. Now, it takes 5 minutes. Just
+ignore the 300+ hours I spent putting it together.
+
+## Installing
+1. Install MySQL, Apache, and git
+2. clone project to /some/path/banwebplus
+3. access /some/path/banwebplus in a web browser (may require some amount of Apache configuration)
+4. follow the steps necessary to make all statuses successful (green)
+
+## Features
+* select classes
+* easily view classes that conflict with those you've already selected
+* either log in as a user or a guest
+* guest settings are saved on the local machine
+* view your schedule in a concise overview
+* view a calendar view
+* import calendar into google calendar/outlook calendar/icalendar
+* share schedule with a friend
+* create custom classes
+* share custom classes
+* whitelist or blacklist certain class criteria
+* report bugs/provide feedback
+* multiple semesters, complete with course history
+* scrape data off of the [existing NMT website](https://banweb7.nmt.edu/pls/PROD/hwzkcrof.p_uncgslctcrsoff)