Create README.md

README.md

@@ -0,0 +1,86 @@
+Places
+==========
+
+Places is a sample application demonstrating the usage of Place Monitor API and 
+geofences in Windows Phone 8.1. This application shows all the known places on 
+the map, draws a circle of known radius around them, and creates equal-sized 
+geofences on those locations. The user is able to switch between the known places 
+by using the map or the application bar buttons.
+
+1. Instructions
+--------------------------------------------------------------------------------
+
+Learn about the Lumia SensorCore SDK from the Lumia Developer's Library. The
+example requires the Lumia SensorCore SDK's NuGet package but will retrieve it
+automatically (if missing) on first build.
+
+To build the application you need to have Windows 8.1 and Windows Phone SDK 8.1
+installed.
+
+Using the Windows Phone 8.1 SDK:
+
+1. Open the SLN file: File > Open Project, select the file `places.sln`
+2. Remove the "AnyCPU" configuration (not supported by the Lumia SensorCore SDK)
+or simply select ARM
+3. Select the target 'Device'.
+4. Press F5 to build the project and run it on the device.
+
+Please see the official documentation for
+deploying and testing applications on Windows Phone devices:
+http://msdn.microsoft.com/en-us/library/gg588378%28v=vs.92%29.aspx
+
+
+2. Implementation
+--------------------------------------------------------------------------------
+
+**Important files and classes:**
+
+The main functionality is in the MapPage.xaml.Sensors.cs file, which handles all the 
+SensorCore SDK related activities. The CreateGeoFence method creates the geofences 
+around known places, and CreateCircle is method which draws the actual circles. 
+UpdateKnownPlacesAsync is the method which queries the SensorCore SDK Place Monitor 
+for all the known places and draws them on the map. 
+
+The API is called through the CallSensorcoreApiAsync() helper function, which helps
+handling the typical errors, like required features being disabled in the system
+settings.
+
+**Required capabilities:**
+
+The SensorSore SDK (via its NuGet package) automatically inserts in the manifest
+file the capabilities required for it to work:
+
+    <DeviceCapability Name="location" />
+    <m2:DeviceCapability Name="humaninterfacedevice">
+      <m2:Device Id="vidpid:0421 0716">
+        <m2:Function Type="usage:ffaa 0001" />
+        <m2:Function Type="usage:ffee 0001" />
+        <m2:Function Type="usage:ffee 0002" />
+        <m2:Function Type="usage:ffee 0003" />
+        <m2:Function Type="usage:ffee 0004" />
+      </m2:Device>
+    </m2:DeviceCapability>
+
+
+3. License
+--------------------------------------------------------------------------------
+
+See the license text file delivered with this project. The license file is also
+available online at https://github.com/nokia-developer/places/blob/master/License.txt
+
+
+4. Version history
+--------------------------------------------------------------------------------
+
+* Version 1.0: The first release.
+
+
+5. See also
+--------------------------------------------------------------------------------
+
+The projects listed below are exemplifying the usage of the other SensorCore APIs
+
+* Steps -  https://github.com/nokia-developer/steps
+* Recorder - https://github.com/nokia-developer/recorder
+* Tracks - https://github.com/nokia-developer/tracks
+* Activities - https://github.com/nokia-developer/activities