Skip to content
This repository has been archived by the owner on Sep 24, 2024. It is now read-only.

Fix README headlines #64

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix README headlines #64

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,26 @@
# :zap:Magic Mirror:zap:

##Overview
## Overview

We took the magic mirror concept a step further by enabling user recognition :smiley:. The mirror can recognize registered users and personalize the experience accordingly.

The Magic Mirror is a fun weekend IoT project that showcases the power of [Universal Windows Platform (UWP) hosted web apps](https://microsoftedge.github.io/WebAppsDocs/en-US/win10/HWA.htm). Please check out the instructions below to see how you can build it yourself :rocket:.

The client side was coded against standard web technologies (CSS, HTML, JS) :heart:, and the back-end leverages the power of NodeJS and Mongo hosted on Azure. The client side implements Windows API ([mediaCapture](https://msdn.microsoft.com/en-us/library/windows/apps/windows.media.capture.aspx)) to detect faces from the devices camera, and the [Microsoft's Cognitive Services Face API](https://www.projectoxford.ai/face) to match Faces to profiles.

##User Flow
## User Flow

Before using the magic mirror, users need to create a profile using the desktop app. You need a profile so the mirror can recognize you and adapt to your needs.

##Assembly Process
## Assembly Process

Please see the [assembly process section](.github/ASSEMBLY.md).

##Installing the apps
## Installing the apps

You have to deploy two Hosted Web apps (HWA). The first HWA allows you to create your profile and is meant to run on your desktop. The second HWA powers the Magic Mirror UI that runs on the Raspberry Pi 2/3.

###Deploying on a PC
### Deploying on a PC

Prerequisites:

Expand Down Expand Up @@ -48,15 +48,15 @@ Steps to deploy the Magic Mirror app to the Raspberry Pi 2:

You can find a tutorial of how to deploy HWA using Visual Studio [here](https://microsoftedge.github.io/WebAppsDocs/en-US/win10/DeployToPiWithVS.htm).

###Deploying on a Mac
### Deploying on a Mac

Coming soon...

## Contributing

For guidelines on contributing to this project, please refer to the [contributing section](.github/CONTRIBUTING.md).

##Run Locally
## Run Locally

Please see the [run locally section](.github/RUNLOCALLY.md).

Expand Down