Merge pull request #6 from ThinkerPal/readme

Readme and Licences

LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Cheryl, Jia Chen, Sebastian, Rui Yang, Xenia
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,72 @@
+# GRACE
+## A new way to interact with elevators
+
+> By **Can I have a breakout room?**
+> - [Rui Yang](https://github.com/thinkerpal/)
+> - [Jia Chen](https://github.com/jiachenyee/)
+> - [Sebastian](http://github.com/SebasChoo04/)
+> - [Xenia](https://github.com/XeniaFiorenza/)
+> - [Cheryl](https://github.com/Cheryl-L/)
+
+This is a code submission for the [Brainhack 2021 CODE_EXP Competition](http://codeexp.tk.sg)
+
+<img src="./appicon.png" width=256/>
+
+---
+
+## What is GRACE?
+GRACE stands for:
+
+ **G**eneral - compatible with many lifts throughout Singapore
+
+ **R**emotely - operated directly from users' mobile phones
+
+ **A**ccesible - features cater to the visually impairsed
+
+ **C**ontactless - reduce contact points to decrease risk of disease transmission
+
+ **E**levators - Elevator!!!
+
+## Why GRACE?
+### Problem Statement
+**“How can we better adjust and adapt into New Norms in a Post-Covid world?”**
+
+> The world was hit by Covid-19 and we have been compelled to experience an unprecedented shift in our lifestyle and the need to adapt to various new norms. Adjusting to changes can pose quite a challenge, especially when it affects our daily routine, be it the way we work and study, or the way we socialise and connect. However, adaptation is inevitable as Covid-19 may be here to stay and has, and will continue to change the way we live.
+
+> The CODE_EXP 2021 problem statement focuses on the possible ways to better aid people in adjusting and adapting to new norms in this post-pandemic world. The targeted benefitting group may include the general public or vulnerable groups such as the elderly, patients in clinics/hospitals, and medical staff.
+
+### What we've identified
+Given that COVID-19 is likely to be endemic, we would need to incorporate new norms into our daily lives, such as an increased consciousness of hygiene, and heightened measures to reduce risk of disease transmission like safe distancing, are here to stay
+
+However, not everyone is able to adapt well to these changes, and certain groups of people may face greater difficulties and be 'left behind'
+
+### Problem Scope
+> Reducing the risk of disease transmission in public spaces via high contact points such as lift buttons, through an app that allows fully contactless interaction with controls that are accessible to the visually impaired
+
+### Target Audience 
+- Visually Impaired people
+    - These people rely on touch to navigate (eg. by reading Braille or embossed text), leading to a higher risk of disease spread by touching public surfaces
+        - Current measures to reduce contact in public surfaces such as holographic/hover lift buttons are not accessible to these people
+    - Not all are able to navigate using touch, and rely on verbally asking other for help. This is difficult when close contact is discouraged
+        - This results in them being more dependent on others
+- General public
+    - Reduce overall risk of transmission in places like HDB flats, preventing clusters arising from spread of disease through touching public surfaces
+
+## Technical Details
+
+### Technologies used:
+- [BBC micro:bit v2](https://microbit.org)
+    - This is used to simulate the hardware lift and lobby interface in our prototype
+- [Swift/Xcode](https://developer.apple.com/swift)
+    - IDE of choice for iOS App Development
+- [UIKit](https://developer.apple.com/documentation/uikit)
+    - Used for front-end Development
+- [CoreBluetooth](https://developer.apple.com/documentation/corebluetooth)
+    - Used in communications between the micro:bit and iPhone
+- MS-DOS
+    - Custom built interface between the micro:bit and Swift. 
+    - It integrates directly into [CoreBluetooth](https://developer.apple.com/documentation/corebluetooth) and abstracts most of [CoreBluetooth](https://developer.apple.com/documentation/corebluetooth) boilerplate functions and manages pairing.
+
+### Technical Flowchart
+![Technical Flowchart](./flowchart.png)
+