From b0ea91e99625511a62cf683bba0db5a54fb3f9c3 Mon Sep 17 00:00:00 2001 From: Karl Erickson Date: Fri, 20 Mar 2015 15:32:13 -0700 Subject: [PATCH] readme scrub scrubbed readme files of Win8.1/VS2013 references, and updated boilerplate sections --- accelerometer/readme.md | 55 ++++++---------- activitysensor/readme.md | 50 ++++++-------- altimeter/readme.md | 44 +++++-------- backgroundtransfer/readme.md | 86 ++++++------------------ barometer/readme.md | 47 +++++--------- bluetoothadvertisement/readme.md | 39 ++++------- compass/readme.md | 52 ++++++--------- customsensors/readme.md | 47 +++++--------- geolocation/readme.md | 27 ++++---- gyrometer/readme.md | 90 ++++++-------------------- inclinometer/readme.md | 51 +++++---------- lamp/readme.md | 74 +++++++++++---------- lightsensor/readme.md | 52 +++++---------- mapcontrolsample/readme.md | 38 ++++++----- orientation/readme.md | 58 ++++++----------- proximitysensor/readme.md | 47 +++++--------- relativeinclinometer/readme.md | 46 +++++-------- relativeorientation/readme.md | 46 +++++-------- simpleorientation/readme.md | 47 +++++--------- smssendandreceive/readme.md | 39 ++++++----- speechandtts/readme.md | 49 ++++++++++---- streamsocket/readme.md | 108 ++++++++++--------------------- xml/readme.md | 48 ++++++++++---- xmllite/readme.md | 36 ++++++++--- 24 files changed, 497 insertions(+), 779 deletions(-) diff --git a/accelerometer/readme.md b/accelerometer/readme.md index 07829cfc33..c46459f004 100644 --- a/accelerometer/readme.md +++ b/accelerometer/readme.md @@ -1,10 +1,7 @@ -Accelerometer sensor sample -=========================== +# Accelerometer sensor sample This sample shows how to use the [**Accelerometer**](http://msdn.microsoft.com/library/windows/apps/br225687) API. -**Note**  This sample was created using one of the universal app templates available in Visual Studio. It shows how its solution is structured so it can run on both Windows 10 and Windows Phone 10. - This sample allows the user to view the acceleration forces along the X-, Y-, and Z-axes for a 3-axis accelerometer. You can choose one of four scenarios: - Accelerometer data events @@ -12,26 +9,23 @@ This sample allows the user to view the acceleration forces along the X-, Y-, an - Poll accelerometer readings - Accelerometer orientation changed -**Acclerometer Data Events** +### Acclerometer Data Events When you choose the **Enable** button for the **Data Events** option, the app begins streaming accelerometer readings in real time. -**Accelerometer Shake Events** +### Accelerometer Shake Events When you choose the **Enable** button for the **Shake Events** option, the app displays the cumulative number of shake events each time an event occurs. (The app first increments the event count and then renders the most recent value.) -**Poll Accelerometer Readings** +### Poll Accelerometer Readings When you choose the **Enable** button for the **Polling** option, the app will retrieve the sensor readings at a fixed interval. -**Accelerometer Orientation Changed** +### Accelerometer Orientation Changed When you choose the **Enable** button for the **OrientationChange** option, the app will display both raw sensor readings, as well as sensor readings that align with the current display orientation. -**Note**  For Windows 8 app samples, download the [Windows 8 app samples pack](http://go.microsoft.com/fwlink/p/?LinkId=301698). The samples in the Windows 8 app samples pack will build and run only on Microsoft Visual Studio 2012. - -Related topics --------------- +## Related topics [**Accelerometer.GetCurrentReading method**](http://msdn.microsoft.com/library/windows/apps/br225699) @@ -43,38 +37,29 @@ Related topics [Windows 8 app samples](http://go.microsoft.com/fwlink/p/?LinkID=227694) -Operating system requirements ------------------------------ - -Client +## System requirements -Windows 10 +**Client:** Windows 10 Technical Preview -Server +**Server:** Windows 10 Technical Preview -None supported +**Phone:** Windows 10 Technical Preview -Phone +## Build the sample -Windows Phone 10 +1. Start Microsoft Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. +2. Go to the directory to which you +3. unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++, C#, or JavaScript. Double-click the Visual Studio 2015 Solution (.sln) file. +3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. -Build the sample ----------------- - -1. Start Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. -2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++ or C\#. Double-click the Visual Studio 2015 Solution (.sln) file. -3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. - -Run the sample --------------- +## Run the sample The next steps depend on whether you just want to deploy the sample or you want to both deploy and run it. -**Deploying the sample** - -1. Select **Build** \> **Deploy Solution**. +### Deploying the sample -**Deploying and running the sample** +- Select Build > Deploy Solution. -1. To debug the sample and then run it, press F5 or select **Debug** \> **Start Debugging**. To run the sample without debugging, press Ctrl+F5 or select**Debug** \> **Start Without Debugging**. +### Deploying and running the sample +- To debug the sample and then run it, press F5 or select Debug > Start Debugging. To run the sample without debugging, press Ctrl+F5 or selectDebug > Start Without Debugging. diff --git a/activitysensor/readme.md b/activitysensor/readme.md index 9e95fb43be..6e631be0bc 100644 --- a/activitysensor/readme.md +++ b/activitysensor/readme.md @@ -1,9 +1,7 @@ -Activity Detection Sensor Sample -================================ +# Activity Detection Sensor Sample This sample demonstrates the use of the Windows.Devices.Sensors.ActivitySensor API. -**Note**  This sample was created using one of the universal app templates available in Visual Studio. It shows how its solution is structured so it can run on both Windows 10 and Windows Phone 10. This sample allows the user to interact with the activity detection functionality on the system. You can choose one of four scenarios: @@ -12,56 +10,44 @@ This sample allows the user to interact with the activity detection functionalit - Events - Background activity -**Current activity** +### Current activity Gets the default activity sensor and displays the current activity. -**History** +### History Gets the activity history from at most 1 day ago. Displays the first entry, last entry, and count of entries. -**Events** +### Events Subscribes to reading and status changed events and displays the updated activity reading and sensor status. -**Background activity** +### Background activity Registers a background task for activity changes. The background task runs whenever the most likely activity changes to/from any of the subscribed activities. -**Note**  For Windows 8 app samples, download the [Windows 8 app samples pack](http://go.microsoft.com/fwlink/p/?LinkId=301698). The samples in the Windows 8 app samples pack will build and run only on Microsoft Visual Studio 2012. +## System requirements -Operating system requirements ------------------------------ +**Client:** Windows 10 Technical Preview -Client +**Server:** Windows 10 Technical Preview -Windows 10 +**Phone:** Windows 10 Technical Preview -Server +## Build the sample -None supported +1. Start Microsoft Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. +2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++, C#, or JavaScript. Double-click the Visual Studio 2015 Solution (.sln) file. +3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. -Phone - -Windows Phone 10 - -Build the sample ----------------- - -1. Start Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. -2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++ or C\#. Double-click the Visual Studio 2015 Solution (.sln) file. -3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. - -Run the sample --------------- +## Run the sample The next steps depend on whether you just want to deploy the sample or you want to both deploy and run it. -**Deploying the sample** - -1. Select **Build** \> **Deploy Solution**. +### Deploying the sample -**Deploying and running the sample** +- Select Build > Deploy Solution. -1. To debug the sample and then run it, press F5 or select **Debug** \> **Start Debugging**. To run the sample without debugging, press Ctrl+F5 or select**Debug** \> **Start Without Debugging**. +### Deploying and running the sample +- To debug the sample and then run it, press F5 or select Debug > Start Debugging. To run the sample without debugging, press Ctrl+F5 or selectDebug > Start Without Debugging. diff --git a/altimeter/readme.md b/altimeter/readme.md index b9811b59e6..337e35ed26 100644 --- a/altimeter/readme.md +++ b/altimeter/readme.md @@ -3,55 +3,41 @@ Altimeter Sample This sample demonstrates the use of the Windows.Devices.Sensors.Altimeter API. -**Note**  This sample was created using one of the universal app templates available in Visual Studio. It shows how its solution is structured so it can run on both Windows 10 and Windows Phone 10. - This sample allows the user to view the change in altitude reading as a value in meters. You can choose one of two scenarios: - Altimeter Data Events - Polling Altimeter Readings -**Altimeter Data Events** +### Altimeter Data Events When you choose the **Enable** button for the **Data Events** option, the app will begin streaming Altimeter readings in real time. -**Polling Altimeter Readings** +### Polling Altimeter Readings When you choose the **Get Data** button for the **Polling** option, the app will retrieve the current sensor readings. -**Note**  For Windows 8 app samples, download the [Windows 8 app samples pack](http://go.microsoft.com/fwlink/p/?LinkId=301698). The samples in the Windows 8 app samples pack will build and run only on Microsoft Visual Studio 2012. - -Operating system requirements ------------------------------ - -Client +## System requirements -Windows 10 +**Client:** Windows 10 Technical Preview -Server +**Server:** Windows 10 Technical Preview -None supported +**Phone:** Windows 10 Technical Preview -Phone +## Build the sample -Windows Phone 10 +1. Start Microsoft Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. +2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++, C#, or JavaScript. Double-click the Visual Studio 2015 Solution (.sln) file. +3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. -Build the sample ----------------- - -1. Start Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. -2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++ or C\#. Double-click the Visual Studio 2015 Solution (.sln) file. -3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. - -Run the sample --------------- +## Run the sample The next steps depend on whether you just want to deploy the sample or you want to both deploy and run it. -**Deploying the sample** - -1. Select **Build** \> **Deploy Solution**. +### Deploying the sample -**Deploying and running the sample** +- Select Build > Deploy Solution. -1. To debug the sample and then run it, press F5 or select **Debug** \> **Start Debugging**. To run the sample without debugging, press Ctrl+F5 or select**Debug** \> **Start Without Debugging**. +### Deploying and running the sample +- To debug the sample and then run it, press F5 or select Debug > Start Debugging. To run the sample without debugging, press Ctrl+F5 or selectDebug > Start Without Debugging. diff --git a/backgroundtransfer/readme.md b/backgroundtransfer/readme.md index cb9445a052..6fab1a6877 100644 --- a/backgroundtransfer/readme.md +++ b/backgroundtransfer/readme.md @@ -1,10 +1,7 @@ -Background Transfer sample -========================== +# Background Transfer sample This sample shows how to use the Background Transfer API to download and upload files in the background in Windows Runtime apps. -**Note**  This sample was created using one of the universal app templates available in Visual Studio. It shows how its solution is structured so it can run on both Windows 8.1 and Windows Phone 8.1. For more info about how to build apps that target Windows and Windows Phone with Visual Studio, see [Build apps that target Windows and Windows Phone 8.1 by using Visual Studio](http://msdn.microsoft.com/library/windows/apps/dn609832). - Classes in the [**Windows.Networking.BackgroundTransfer**](http://msdn.microsoft.com/library/windows/apps/br207242) namespace provide a power-friendly, cost-aware, and flexible API for transferring files in the background. This sample shows how to download and upload files using the Background Transfer API. For the download scenario, the sample first uses methods on [**BackgroundDownloader**](http://msdn.microsoft.com/library/windows/apps/br207126) class to enumerate any downloads that were going on in the background while the app was closed. An app should enumerate these downloads when it gets started so it can attach a progress handler to these downloads to track progress and prevent stale downloads. Then other methods on the **BackgroundDownloader** and related classes are used to start new downloads to the local Pictures Library. The sample also shows how to pause downloads and change the priority of a download. @@ -45,30 +42,9 @@ For more information on network capabilities, see [How to set network capabiliti **Note**  Background Transfer is only enabled on Windows if at least one of the networking capabilities is set: **Internet (Client)**, **Internet (Client & Server)**, or **Private Networks (Client & Server)**. -This sample is currently provided in the JavaScript, C\#, VB, and C++ programming languages. - -To obtain an evaluation copy of Windows 8.1, go to [Windows 8.1](http://go.microsoft.com/fwlink/p/?linkid=301696). - -To obtain an evaluation copy of Microsoft Visual Studio 2013 Update 2, go to [Microsoft Visual Studio 2013](http://go.microsoft.com/fwlink/p/?linkid=301697). - -**Note**  For Windows 8 app samples, download the [Windows 8 app samples pack](http://go.microsoft.com/fwlink/p/?LinkId=301698). The samples in the Windows 8 app samples pack will build and run only on Microsoft Visual Studio 2012. - -Related topics --------------- - -**Other resources** - -[Adding support for networking](http://msdn.microsoft.com/library/windows/apps/hh452752) - -[How to configure network isolation capabilities](http://msdn.microsoft.com/library/windows/apps/hh770532) - -[Quickstart: Downloading a file](http://msdn.microsoft.com/library/windows/apps/hh700370) - -[Quickstart: Uploading a file](http://msdn.microsoft.com/library/windows/apps/hh700372) - -[Transferring a file from a network resource](http://msdn.microsoft.com/library/windows/apps/hh761434) +## Related topics -**Reference** +### Reference [**BackgroundDownloader**](http://msdn.microsoft.com/library/windows/apps/br207126) @@ -84,57 +60,33 @@ Related topics [**XHR**](http://msdn.microsoft.com/library/windows/apps/br229787) -**Samples** - -[Windows 8 app samples](http://go.microsoft.com/fwlink/p/?LinkID=227694) - -Operating system requirements ------------------------------ - -Client - -Windows 8.1 - -Server +### Other resources -Windows Server 2012 R2 - -Phone - -Windows Phone 8.1 +[Adding support for networking](http://msdn.microsoft.com/library/windows/apps/hh452752) -Build the sample ----------------- +[How to configure network isolation capabilities](http://msdn.microsoft.com/library/windows/apps/hh770532) -1. Start Visual Studio 2013 Update 2 and select **File** \> **Open** \> **Project/Solution**. -2. Go to the directory to which you unzipped the sample. Go to the directory named for the sample, and double-click the Visual Studio 2013 Update 2 Solution (.sln) file. -3. Follow the steps for the version of the sample you want: - - To build the Windows version of the sample: +[Quickstart: Downloading a file](http://msdn.microsoft.com/library/windows/apps/hh700370) - 1. Select **BackgroundTransfer.Windows** in **Solution Explorer**. - 2. Press Ctrl+Shift+B, or use **Build** \> **Build Solution**, or use **Build** \> **Build BackgroundTransfer.Windows**. - - To build the Windows Phone version of the sample: +[Quickstart: Uploading a file](http://msdn.microsoft.com/library/windows/apps/hh700372) - 1. Select **BackgroundTransfer.WindowsPhone** in **Solution Explorer**. - 2. Press Ctrl+Shift+B or use **Build** \> **Build Solution** or use **Build** \> **Build BackgroundTransfer.WindowsPhone**. +[Transferring a file from a network resource](http://msdn.microsoft.com/library/windows/apps/hh761434) -Run the sample --------------- +## System requirements -The next steps depend on whether you just want to deploy the sample or you want to both deploy and run it. +**Client:** Windows 10 Technical Preview -**Deploying the sample** +**Server:** Windows 10 Technical Preview -- To deploy the built Windows version of the sample: +**Phone:** Windows 10 Technical Preview - 1. Select **BackgroundTransfer.Windows** in **Solution Explorer**. - 2. Use **Build** \> **Deploy Solution** or **Build** \> **Deploy BackgroundTransfer.Windows**. -- To deploy the built Windows Phone version of the sample: +## Build the sample - 1. Select **BackgroundTransfer.WindowsPhone** in **Solution Explorer**. - 2. Use **Build** \> **Deploy Solution** or **Build** \> **Deploy BackgroundTransfer.WindowsPhone**. +1. Start Microsoft Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. +2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++, C#, or JavaScript. Double-click the Visual Studio 2015 Solution (.sln) file. +3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. -**Deploying and running the Windows version of the sample** +### Deploying and running the Windows version of the sample This sample requires that a web server is available for the app to access for uploading and downloading files. The web server must be started before the app is run. The web server must also have a *BackgroundTransferSample* path available for uploads and downloads. The sample includes a PowerShell script that will install IIS on the local computer, create the *BackgroundTransferSample* folder on the server, copy files to this folder, create firewall rules to allow access, and enable IIS. @@ -188,7 +140,7 @@ The remote server address and local filename fields should be updated. This can 1. Right-click **BackgroundTransfer.Windows** in **Solution Explorer** and select **Set as StartUp Project**. 2. To debug the sample and then run it, press F5 or use **Debug** \> **Start Debugging**. To run the sample without debugging, press Ctrl+F5 or use **Debug** \> **Start Without Debugging**. -**Deploying and running the Windows Phone version of the sample** +### Deploying and running the Windows Phone version of the sample IIS is not available on Windows Phone. For the app to access a web server, there are two options: diff --git a/barometer/readme.md b/barometer/readme.md index d2c20255ce..d3db825165 100644 --- a/barometer/readme.md +++ b/barometer/readme.md @@ -1,57 +1,42 @@ -Barometer Sample -================ +# Barometer Sample This sample demonstrates the use of the Windows.Devices.Sensors.Barometer API. -**Note**  This sample was created using one of the universal app templates available in Visual Studio. It shows how its solution is structured so it can run on both Windows 10 and Windows Phone 10. - This sample allows the user to view the pressure reading as a hPa value. You can choose one of two scenarios: - Barometer Data Events - Polling Barometer Readings -**Barometer Data Events** +### Barometer Data Events When you choose the **Enable** button for the **Data Events** option, the app will begin streaming barometer readings in real time. -**Polling barometer Readings** +### Polling barometer Readings When you choose the **Get Data** button for the **Polling** option, the app will retrieve the current sensor readings. -**Note**  For Windows 8 app samples, download the [Windows 8 app samples pack](http://go.microsoft.com/fwlink/p/?LinkId=301698). The samples in the Windows 8 app samples pack will build and run only on Microsoft Visual Studio 2012. - -Operating system requirements ------------------------------ - -Client +## System requirements -Windows 10 +**Client:** Windows 10 Technical Preview -Server +**Server:** Windows 10 Technical Preview -None supported +**Phone:** Windows 10 Technical Preview -Phone +## Build the sample -Windows Phone 10 +1. Start Microsoft Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. +2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++, C#, or JavaScript. Double-click the Visual Studio 2015 Solution (.sln) file. +3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. -Build the sample ----------------- - -1. Start Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. -2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++ or C\#. Double-click the Visual Studio 2015 Solution (.sln) file. -3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. - -Run the sample --------------- +## Run the sample The next steps depend on whether you just want to deploy the sample or you want to both deploy and run it. -**Deploying the sample** - -1. Select **Build** \> **Deploy Solution**. +### Deploying the sample -**Deploying and running the sample** +- Select Build > Deploy Solution. -1. To debug the sample and then run it, press F5 or select **Debug** \> **Start Debugging**. To run the sample without debugging, press Ctrl+F5 or select**Debug** \> **Start Without Debugging**. +### Deploying and running the sample +- To debug the sample and then run it, press F5 or select Debug > Start Debugging. To run the sample without debugging, press Ctrl+F5 or selectDebug > Start Without Debugging. diff --git a/bluetoothadvertisement/readme.md b/bluetoothadvertisement/readme.md index b666399749..4d8cdad825 100644 --- a/bluetoothadvertisement/readme.md +++ b/bluetoothadvertisement/readme.md @@ -1,40 +1,29 @@ -Bluetooth Advertisement Watcher and Publisher -============================================= +# Bluetooth Advertisement Watcher and Publisher This sample demonstrates use of the Bluetooth Advertisement Runtime API to send and receive Bluetooth Low Energy advertisements. -Operating system requirements ------------------------------ +## System requirements -Client +**Client:** Windows 10 Technical Preview -Windows 10 +**Server:** Windows 10 Technical Preview -Server +**Phone:** Windows 10 Technical Preview -None supported +## Build the sample -Phone +1. Start Microsoft Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. +2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++, C#, or JavaScript. Double-click the Visual Studio 2015 Solution (.sln) file. +3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. -Windows Phone 10 - -Build the sample ----------------- - -1. Start Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. -2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - C\#. Double-click the Visual Studio 2015 Solution (.sln) file. -3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. - -Run the sample --------------- +## Run the sample The next steps depend on whether you just want to deploy the sample or you want to both deploy and run it. -**Deploying the sample** - -1. Select **Build** \> **Deploy Solution**. +### Deploying the sample -**Deploying and running the sample** +- Select Build > Deploy Solution. -1. To debug the sample and then run it, press F5 or select **Debug** \> **Start Debugging**. To run the sample without debugging, press Ctrl+F5 or select**Debug** \> **Start Without Debugging**. +### Deploying and running the sample +- To debug the sample and then run it, press F5 or select Debug > Start Debugging. To run the sample without debugging, press Ctrl+F5 or selectDebug > Start Without Debugging. diff --git a/compass/readme.md b/compass/readme.md index 8617c6b0d4..abe73514a0 100644 --- a/compass/readme.md +++ b/compass/readme.md @@ -1,69 +1,53 @@ -Compass sensor sample -===================== +# Compass sensor sample This sample demonstrates how to use the [**Windows.Devices.Sensors.Compass**](http://msdn.microsoft.com/library/windows/apps/br225705) API. -**Note**  This sample was created using one of the universal app templates available in Visual Studio. It shows how its solution is structured so it can run on both Windows 10 and Windows Phone 10. - This sample allows the user to view the compass reading as a magnetic-north and, depending on the installed sensor, a true-north value. You can choose one of three scenarios: - Compass data events - Poll compass readings - Sensor calibration -**Compass Data Events** +### Compass Data Events When you choose the **Enable** button for the **Data Events** option, the app begins streaming compass readings in real time. -**Poll Compass Readings** +### Poll Compass Readings When you choose the **Enable** button for the **Polling** option, the app will retrieve the sensor readings at a fixed interval. -**Sensor Calibration** +### Sensor Calibration Allows the user to simulate sensor accuracy and demonstrates usage of the calibration bar. -**Note**  For Windows 8 app samples, download the [Windows 8 app samples pack](http://go.microsoft.com/fwlink/p/?LinkId=301698). The samples in the Windows 8 app samples pack will build and run only on Microsoft Visual Studio 2012. - -Related topics --------------- +## Related topics [Windows.Devices.Sensors namespace](http://go.microsoft.com/fwlink/p/?linkid=241981) [Windows 8 app samples](http://go.microsoft.com/fwlink/p/?LinkID=227694) -Operating system requirements ------------------------------ - -Client +## System requirements -Windows 10 +**Client:** Windows 10 Technical Preview -Server +**Server:** Windows 10 Technical Preview -None supported +**Phone:** Windows 10 Technical Preview -Phone +## Build the sample -Windows Phone 10 +1. Start Microsoft Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. +2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++, C#, or JavaScript. Double-click the Visual Studio 2015 Solution (.sln) file. +3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. -Build the sample ----------------- - -1. Start Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. -2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++ or C\#. Double-click the Visual Studio 2015 Solution (.sln) file. -3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. - -Run the sample --------------- +## Run the sample The next steps depend on whether you just want to deploy the sample or you want to both deploy and run it. -**Deploying the sample** - -1. Select **Build** \> **Deploy Solution**. +### Deploying the sample -**Deploying and running the sample** +- Select Build > Deploy Solution. -1. To debug the sample and then run it, press F5 or select **Debug** \> **Start Debugging**. To run the sample without debugging, press Ctrl+F5 or select**Debug** \> **Start Without Debugging**. +### Deploying and running the sample +- To debug the sample and then run it, press F5 or select Debug > Start Debugging. To run the sample without debugging, press Ctrl+F5 or selectDebug > Start Without Debugging. diff --git a/customsensors/readme.md b/customsensors/readme.md index 6d95c67303..c36172fedc 100644 --- a/customsensors/readme.md +++ b/customsensors/readme.md @@ -1,57 +1,42 @@ -Custom Sensor Sample -==================== +# Custom sensor sample This sample demonstrates the use of the Windows.Devices.Sensors.Custom sensor API. -**Note**  This sample was created using one of the universal app templates available in Visual Studio. It shows how its solution is structured so it can run on both Windows 10 and Windows Phone 10. - This sample allows the user to view the CO2 level for custom sensor based CO2 sensor. You can choose one of two scenarios: - Custom sensor data events - Polling custom sensor readings -**Custom Sensor Data Events** +### Custom Sensor Data Events When you click on the **Enable** button for the **Data Events** option, the app will begin streaming Custom Sensor readings in real time. -**Polling Custom Sensor Readings** +### Polling Custom Sensor Readings When you click on the **Get CO2 level** button for the **Polling** option, the app will retrieve the current sensor readings. -**Note**  For Windows 8 app samples, download the [Windows 8 app samples pack](http://go.microsoft.com/fwlink/p/?LinkId=301698). The samples in the Windows 8 app samples pack will build and run only on Microsoft Visual Studio 2012. - -Operating system requirements ------------------------------ - -Client +## System requirements -Windows 10 +**Client:** Windows 10 Technical Preview -Server +**Server:** Windows 10 Technical Preview -None supported +**Phone:** Windows 10 Technical Preview -Phone +## Build the sample -Windows Phone 10 +1. Start Microsoft Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. +2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++, C#, or JavaScript. Double-click the Visual Studio 2015 Solution (.sln) file. +3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. -Build the sample ----------------- - -1. Start Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. -2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++ or C\#. Double-click the Visual Studio 2015 Solution (.sln) file. -3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. - -Run the sample --------------- +## Run the sample The next steps depend on whether you just want to deploy the sample or you want to both deploy and run it. -**Deploying the sample** - -1. Select **Build** \> **Deploy Solution**. +### Deploying the sample -**Deploying and running the sample** +- Select Build > Deploy Solution. -1. To debug the sample and then run it, press F5 or select **Debug** \> **Start Debugging**. To run the sample without debugging, press Ctrl+F5 or select**Debug** \> **Start Without Debugging**. +### Deploying and running the sample +- To debug the sample and then run it, press F5 or select Debug > Start Debugging. To run the sample without debugging, press Ctrl+F5 or selectDebug > Start Without Debugging. diff --git a/geolocation/readme.md b/geolocation/readme.md index c637bccea6..98080efd8a 100644 --- a/geolocation/readme.md +++ b/geolocation/readme.md @@ -1,7 +1,8 @@ # Geolocation sample -The Geolocation sample demonstrates how to use the Windows.Devices.Geolocation namespace to get the geographic location of the user's device. An app can use the Geolocation namespace to request access to user location, get the location one time, continuously track the location by getting location update events, or get alerts when the device has entered or exited locations of interest. +The Geolocation sample shows how to use the Windows.Devices.Geolocation namespace to get the geographic location of the user's device. An app can use the Geolocation namespace to request access to user location, get the location one time, continuously track the location by getting location update events, or get alerts when the device has entered or exited locations of interest. + +### This sample also shows how to: -###The sample also demonstrates how to: - **Use a [geofence](http://msdn.microsoft.com/library/windows/apps/dn263744):** Receive notifications when the user's device has entered or left an area of interest. - **Handle changes in location permissions**: Register for the Geolocator's StatusChanged event and use the [StatusChangedEventArgs](http://msdn.microsoft.com/library/windows/apps/br225600) to determine the current position status. - **Get location from a background task** @@ -9,20 +10,20 @@ The Geolocation sample demonstrates how to use the Windows.Devices.Geolocation n - **Obtain satellite data:** When available, use the [GeocoordinateSatelliteData](http://msdn.microsoft.com/library/windows/apps/jj635260) class to obtain additional information on the quality of the satellite based location data. - **Display a toast:** Notify the user when a geofencing event has occurred in the background. - **Refresh geofence binding:** Refresh the binding on resume and after removal of a geofence. Note that removal requires subscribing to removal events if a geofence is set as single use or a duration is set. -- **Request access to the user's location:** Request access to the user's location using the RequestAccessAsync method. Important: call the RequestAccessAsync before accessing the user’s location. At that time, your app must be in the foreground and RequestAccessAsync must be called from the UI thread. Until the user grants your app permission to their location, your app can't access location data. +- **Request access to the user's location:** Request access to the user's location using the RequestAccessAsync method. Important: call the RequestAccessAsync before accessing the user’s location. At that time, your app must be in the foreground and RequestAccessAsync must be called from the UI thread. Until the user grants your app permission to their location, your app can't access location data. - **Help the user change location settings:** Link to location privacy settings from your app if the user revokes access to location while your app is in the foreground. Call the LaunchUriAsync method with the URI "ms-settings://privacy/location". Geofences need to be created in the Foreground Geofencing scenario (Scenario 4) and then you can go to Background Geofencing scenario (Scenario 5) to register for background geofencing events. The Geolocation sample formats and parses time and dates in the en-US locale using the Gregorian calendar and 24-hour clock. To help other locales in entering data the edit fields have a format example shown below the control. For example, Start Time would be entered mm/dd/yyyy hh:mm:ss format. February 2, 2014 at 10:34 pm would be written 2/2/2014 22:34:00. For the Dwell Time and Duration the format is dd:hh:mm:ss so a time span of 7 days, 23 hours, 45 minutes and 55 seconds would be written as 7:23:45:55. -###Declaring the Location capability +### Declaring the Location capability This sample requires that location capability be set in the *Package.appxmanifest* file to allow the app to access location at runtime. The capability can be set in the app manifest using Microsoft Visual Studio. -##Related topics --------------- +## Related topics + [Detect a user's location](https://msdn.microsoft.com/en-us/library/windows/apps/xaml/hh465135.aspx) [Respond to location updates](https://msdn.microsoft.com/en-us/library/windows/apps/xaml/hh465142.aspx) @@ -33,30 +34,28 @@ This sample requires that location capability be set in the *Package.appxmanifes [Guidelines for location-aware apps](https://msdn.microsoft.com/library/windows/apps/hh465148) +## System requirements -##System requirements -------------------- **Client:** Windows 10 Technical Preview **Server:** Windows 10 Technical Preview **Phone:** Windows 10 Technical Preview -##Build the sample ----------------- +## Build the sample 1. Start Microsoft Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. 2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++, C#, or JavaScript. Double-click the Visual Studio 2015 Solution (.sln) file. 3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. -##Run the sample --------------- +## Run the sample + The next steps depend on whether you just want to deploy the sample or you want to both deploy and run it. -**Deploying the sample** +### Deploying the sample - Select Build > Deploy Solution. -**Deploying and running the sample** +### Deploying and running the sample - To debug the sample and then run it, press F5 or select Debug > Start Debugging. To run the sample without debugging, press Ctrl+F5 or selectDebug > Start Without Debugging. diff --git a/gyrometer/readme.md b/gyrometer/readme.md index 57cb771edf..6ea68913e3 100644 --- a/gyrometer/readme.md +++ b/gyrometer/readme.md @@ -1,105 +1,51 @@ -Gyrometer sensor sample -======================= +# Gyrometer sensor sample This sample shows how to use the [**Windows.Devices.Sensors.Gyrometer**](http://msdn.microsoft.com/library/windows/apps/br225718) API. -**Note**  This sample was created using one of the universal app templates available in Visual Studio. It shows how its solution is structured so it can run on both Windows 10 and Windows Phone 10. - This sample allows the user to view the angular velocity along the X-, Y-, and Z-axis for a 3-axis gyrometer. You can choose one of three scenarios: - Gyrometer data events - Poll gyrometer readings - Porting gyrometer logic across platforms -**Gyrometer Data Events** +### Gyrometer Data Events When you click the **Enable** button for the **Data Events** option, the app begins streaming gyrometer readings in real time. -**Poll Gyrometer Readings** +### Poll Gyrometer Readings When you click the **Enable** button for the **Polling** option, the app will retrieve the sensor readings at a fixed interval. -**Porting Gyrometer Logic Across Platforms** +### Porting Gyrometer Logic Across Platforms When you click the **Get Sample** button, two sets of readings are displayed: raw gyrometer reading, based on the native orientation of the device, and transformed gyrometer reading based on the native orientation of the device your sensor logic was originally developed for. -**Note**  For Windows 8 app samples, download the [Windows 8 app samples pack](http://go.microsoft.com/fwlink/p/?LinkId=301698). The samples in the Windows 8 app samples pack will build and run only on Microsoft Visual Studio 2012. - -Related topics --------------- - -[Windows 8 app samples](http://go.microsoft.com/fwlink/p/?LinkID=227694) +### Related topics [Windows.Devices.Sensors namespace](http://go.microsoft.com/fwlink/p/?linkid=241981) -Operating system requirements ------------------------------ - -Client - -Windows 8.1 - -Server - -None supported - -Phone - -Windows Phone 8.1 - -Build the sample ----------------- - -1. Start Microsoft Visual Studio 2013 Update 2 and select **File** \> **Open** \> **Project/Solution**. -2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++, C\#, JavaScript, or Visual Basic. Double-click the Visual Studio 2013 Update 2 Solution (.sln) file. -3. Select either the Windows or Windows Phone project version of the sample. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. - -Run the sample --------------- - -The next steps depend on whether you just want to deploy the sample or you want to both deploy and run it. - -**Deploying the sample** - -1. Select either the Windows or Windows Phone project version of the sample. -2. Select **Build** \> **Deploy Solution**. - -**Deploying and running the sample** - -1. Right-click either the Windows or Windows Phone project version of the sample in **Solution Explorer** and select **Set as StartUp Project**. -2. To debug the sample and then run it, press F5 or select **Debug** \> **Start Debugging**. To run the sample without debugging, press Ctrl+F5 or select**Debug** \> **Start Without Debugging**. - -Operating system requirements ------------------------------ - -Client - -Windows 10 - -Server +## System requirements -None supported +**Client:** Windows 10 Technical Preview -Phone +**Server:** Windows 10 Technical Preview -Windows Phone 10 +**Phone:** Windows 10 Technical Preview -Build the sample ----------------- +## Build the sample -1. Start Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. -2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++ or C\#. Double-click the Visual Studio 2015 Solution (.sln) file. -3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. +1. Start Microsoft Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. +2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++, C#, or JavaScript. Double-click the Visual Studio 2015 Solution (.sln) file. +3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. -Run the sample --------------- +## Run the sample The next steps depend on whether you just want to deploy the sample or you want to both deploy and run it. -**Deploying the sample** +### Deploying the sample -1. Select **Build** \> **Deploy Solution**. +- Select Build > Deploy Solution. -**Deploying and running the sample** +### Deploying and running the sample -1. To debug the sample and then run it, press F5 or select **Debug** \> **Start Debugging**. To run the sample without debugging, press Ctrl+F5 or select**Debug** \> **Start Without Debugging**. +- To debug the sample and then run it, press F5 or select Debug > Start Debugging. To run the sample without debugging, press Ctrl+F5 or selectDebug > Start Without Debugging. diff --git a/inclinometer/readme.md b/inclinometer/readme.md index c805a03453..7938a5fca6 100644 --- a/inclinometer/readme.md +++ b/inclinometer/readme.md @@ -1,69 +1,52 @@ -Inclinometer sensor sample -========================== +# Inclinometer sensor sample This sample shows how to use the [**Windows.Devices.Sensors.Inclinometer**](http://msdn.microsoft.com/library/windows/apps/br225766) API. -**Note**  This sample was created using one of the universal app templates available in Visual Studio. It shows how its solution is structured so it can run on both Windows 10 and Windows Phone 10. - This sample allows the user to view the angles of incline about the X-, Y-, and Z-axis for a 3-axis inclinometer. (The incline about the X-axis corresponds to the pitch value; the incline about the Y-axis corresponds to the roll value; and the incline about the Z-axis corresponds to the yaw value.) You can choose one of three scenarios: - Inclinometer data events - Poll inclinometer readings - Sensor calibration -**Inclinometer Data Events** +### Inclinometer Data Events When you click the **Enable** button for the **Data Events** option, the app begins streaming inclinometer readings in real time. -**Poll Inclinometer Readings** +### Poll Inclinometer Readings When you choose the **Enable** button for the **Polling** option, the app will retrieve the sensor readings at a fixed interval. -**Sensor Calibration** +### Sensor Calibration Allows the user to simulate sensor accuracy and demonstrates usage of the calibration bar. -**Note**  For Windows 8 app samples, download the [Windows 8 app samples pack](http://go.microsoft.com/fwlink/p/?LinkId=301698). The samples in the Windows 8 app samples pack will build and run only on Microsoft Visual Studio 2012. - Related topics -------------- [Windows.Devices.Sensors namespace](http://go.microsoft.com/fwlink/p/?linkid=241981) -[Windows 8 app samples](http://go.microsoft.com/fwlink/p/?LinkID=227694) - -Operating system requirements ------------------------------ - -Client +## System requirements -Windows 10 +**Client:** Windows 10 Technical Preview -Server +**Server:** Windows 10 Technical Preview -None supported +**Phone:** Windows 10 Technical Preview -Phone +## Build the sample -Windows Phone 10 +1. Start Microsoft Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. +2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++, C#, or JavaScript. Double-click the Visual Studio 2015 Solution (.sln) file. +3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. -Build the sample ----------------- - -1. Start Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. -2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++ or C\#. Double-click the Visual Studio 2015 Solution (.sln) file. -3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. - -Run the sample --------------- +## Run the sample The next steps depend on whether you just want to deploy the sample or you want to both deploy and run it. -**Deploying the sample** - -1. Select **Build** \> **Deploy Solution**. +### Deploying the sample -**Deploying and running the sample** +- Select Build > Deploy Solution. -1. To debug the sample and then run it, press F5 or select **Debug** \> **Start Debugging**. To run the sample without debugging, press Ctrl+F5 or select**Debug** \> **Start Without Debugging**. +### Deploying and running the sample +- To debug the sample and then run it, press F5 or select Debug > Start Debugging. To run the sample without debugging, press Ctrl+F5 or selectDebug > Start Without Debugging. diff --git a/lamp/readme.md b/lamp/readme.md index 54db2ef2ce..cdfd2aa4cb 100644 --- a/lamp/readme.md +++ b/lamp/readme.md @@ -7,54 +7,52 @@ is no longer seen as a slave peripheral controlled by the capture device. Specifically, this sample covers the three most common scenarios for utilizing the flash: -Scenario 1: Acquiring a Lamp instance. There are two methods to acquire the lamp device: - 1) When you choose the "Get Lamp Instance from Device Information", this demonstrates acquiring Lamp via querying DeviceInformation with class - selection string for Lamp. In this scenario, you have more control over picking what specific lamp device you'd like to use. For the demonstration, - we grab the back lamp device which is most common lamp location. - 2) When you choose the "Get Default Lamp Instance", this is the more simplified method is to just get the default lamp device. - -Scenario 2: Enable Lamp and Settings adjustment. This scenario demonstrates determining the capabilities of the lamp, and adjusting those capabilities. - 1) When you choose "Adjust Brightness and turn on Lamp", this queries the lamp device for Brightness capability, and demonstrates adjusting the lamp - brightness setting to 0.5 or 50%. - 2) When you choose "Adjust Color", this queries the lamp device for Color capability, and demonstrates adjusting the color lamp color to Blue - -Scenario 3: Lamp Device Change Events. This sample demonstrates registering for lamp AvailablityChanged event. Lamp devices can be acquired by another -applications that utilize camera at any time when lamp is in use. When this happens, a AvailiablityChanged event will fire. In this scenario we demonstrate registering +**Scenario 1: Acquiring a Lamp instance.** There are two methods to acquire the lamp device: + +1. When you choose the "Get Lamp Instance from Device Information", this demonstrates acquiring Lamp via querying DeviceInformation with class selection string for Lamp. In this scenario, you have more control over picking what specific lamp device you'd like to use. For the demonstration, we grab the back lamp device which is most common lamp location. +2. When you choose the "Get Default Lamp Instance", this is the more simplified method is to just get the default lamp device. + +**Scenario 2: Enable Lamp and Settings adjustment.** This scenario demonstrates determining the capabilities of the lamp, and adjusting those capabilities. + +1. When you choose "Adjust Brightness and turn on Lamp", this queries the lamp device for Brightness capability, and demonstrates adjusting the lamp brightness setting to 0.5 or 50%. +2. When you choose "Adjust Color", this queries the lamp device for Color capability, and demonstrates adjusting the color lamp color to Blue. + +**Scenario 3: Lamp Device Change Events.** This sample demonstrates registering for lamp AvailablityChanged event. Lamp devices can be acquired by another +applications that utilize camera at any time when lamp is in use. When this happens, an AvailiablityChanged event will fire. In this scenario we demonstrate registering for the AvailabillityChanged event and handling that event with a message to the user. In this scenario we acquire the default lamp device page turns on, and provide a toggle to turn the lamp on so you can see the AvailablityChanged event fire by launching another app (Camera app will suffice) and turning on the flash. - 1) When you choose "Register for AvailaiblityChanged Event", this registers for the event - 2) When you choose "Unregister for AvailaiblityChanged Event", this unregisters for the event. -Related topics --------------- +1. When you choose "Register for AvailaiblityChanged Event", this registers for the event. +2. When you choose "Unregister for AvailaiblityChanged Event", this unregisters for the event. + +## Related topics -[Windows.Media.Devices namespace] (https://msdn.microsoft.com/en-us/library/windows/apps/windows.media.devices.aspx) +[Windows.Media.Devices namespace](https://msdn.microsoft.com/en-us/library/windows/apps/windows.media.devices.aspx) -Windows 8 and 8.1 method for turning on flash (requires starting a video recording session) -[Windows.Media.Devices.VideoDeviceController.TorchControl] (https://msdn.microsoft.com/en-us/library/windows/apps/windows.media.devices.videodevicecontroller.torchcontrol.aspx) -**Samples** +## System requirements -System requirements ------------------------------ -Camera with Flash Device -Client -Windows 10 -Windows Phone 10 +**Hardware:** Camera with flash device -Build the sample ----------------- +**Client:** Windows 10 Technical Preview -1. Start Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. -2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++, C\#, or JavaScript. Double-click the Visual Studio 2015 Solution (.sln) file. -3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. +**Server:** Windows 10 Technical Preview -Run the sample --------------- +**Phone:** Windows 10 Technical Preview + +## Build the sample + +1. Start Microsoft Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. +2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++, C#, or JavaScript. Double-click the Visual Studio 2015 Solution (.sln) file. +3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. + +## Run the sample The next steps depend on whether you just want to deploy the sample or you want to both deploy and run it. -**Deploying the sample** -1. Select **Build** \> **Deploy Solution**. +### Deploying the sample + +- Select Build > Deploy Solution. + +### Deploying and running the sample -**Deploying and running the sample** -1. To debug the sample and then run it, press F5 or select **Debug** \> **Start Debugging**. To run the sample without debugging, press Ctrl+F5 or select**Debug** \> **Start Without Debugging**. \ No newline at end of file +- To debug the sample and then run it, press F5 or select Debug > Start Debugging. To run the sample without debugging, press Ctrl+F5 or selectDebug > Start Without Debugging. diff --git a/lightsensor/readme.md b/lightsensor/readme.md index bb2873f53c..3d0f2fd282 100644 --- a/lightsensor/readme.md +++ b/lightsensor/readme.md @@ -1,64 +1,46 @@ -LightSensor sample -================== +# LightSensor sample This sample shows how to use the [**Windows.Devices.Sensors.LightSensor**](http://msdn.microsoft.com/library/windows/apps/br225790) API. -**Note**  This sample was created using one of the universal app templates available in Visual Studio. It shows how its solution is structured so it can run on both Windows 10 and Windows Phone 10. - This sample allows the user to view the ambient light reading as a LUX value. You can choose one of two scenarios: - LightSensor data events - Poll light sensor readings -**LightSensor Data Events** +### LightSensor Data Events When you click the **Enable** button for the **Data Events** option, the app begins streaming light-sensor readings in real time. -**Poll LightSensor Readings** +### Poll LightSensor Readings When you click the **Enable** button for the **Polling** option, the app will retrieve the sensor readings at a fixed interval. -**Note**  For Windows 8 app samples, download the [Windows 8 app samples pack](http://go.microsoft.com/fwlink/p/?LinkId=301698). The samples in the Windows 8 app samples pack will build and run only on Microsoft Visual Studio 2012. - -Related topics --------------- +## Related topics [Windows.Devices.Sensors namespace](http://go.microsoft.com/fwlink/p/?linkid=241981) -[Windows 8 app samples](http://go.microsoft.com/fwlink/p/?LinkID=227694) - -Operating system requirements ------------------------------ - -Client +## System requirements -Windows 10 +**Client:** Windows 10 Technical Preview -Server +**Server:** Windows 10 Technical Preview -None supported +**Phone:** Windows 10 Technical Preview -Phone +## Build the sample -Windows Phone 10 +1. Start Microsoft Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. +2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++, C#, or JavaScript. Double-click the Visual Studio 2015 Solution (.sln) file. +3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. -Build the sample ----------------- - -1. Start Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. -2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++ or C\#. Double-click the Visual Studio 2015 Solution (.sln) file. -3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. - -Run the sample --------------- +## Run the sample The next steps depend on whether you just want to deploy the sample or you want to both deploy and run it. -**Deploying the sample** - -1. Select **Build** \> **Deploy Solution**. +### Deploying the sample -**Deploying and running the sample** +- Select Build > Deploy Solution. -1. To debug the sample and then run it, press F5 or select **Debug** \> **Start Debugging**. To run the sample without debugging, press Ctrl+F5 or select**Debug** \> **Start Without Debugging**. +### Deploying and running the sample +- To debug the sample and then run it, press F5 or select Debug > Start Debugging. To run the sample without debugging, press Ctrl+F5 or selectDebug > Start Without Debugging. diff --git a/mapcontrolsample/readme.md b/mapcontrolsample/readme.md index 2cf33bc857..245f0158ee 100644 --- a/mapcontrolsample/readme.md +++ b/mapcontrolsample/readme.md @@ -1,5 +1,4 @@ -Windows map sample for UAP (C#) -=============================== +# MapControl sample This sample demonstrates how to use the universal map control [MapControl]( https://msdn.microsoft.com/en-us/library/windows/apps/xaml/windows.ui.xaml.controls.maps.mapcontrol.aspx) in a universal Windows app (UAP). @@ -7,31 +6,36 @@ This sample demonstrates how to use the universal map control [MapControl]( http * Adding points of interest on the map: PushPins, images, and shapes * Adding XAML overlays on the map -This sample is written in XAML and C#. - -For more info --------------- +## Related topics [How to display maps in the Map control](https://msdn.microsoft.com/en-us/library/windows/apps/xaml/dn642089.aspx) + [How to display pushpins, shapes, and controls on a map](https://msdn.microsoft.com/en-us/library/windows/apps/xaml/dn792121.aspx) + [MapControl API reference]( https://msdn.microsoft.com/en-us/library/windows/apps/xaml/windows.ui.xaml.controls.maps.mapcontrol.aspx) +## System requirements + +**Client:** Windows 10 Technical Preview + +**Server:** Windows 10 Technical Preview + +**Phone:** Windows 10 Technical Preview -Operating system requirements ------------------------------ +## Build the sample -Client: Windows 10 Technical Preview +1. Start Microsoft Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. +2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++, C#, or JavaScript. Double-click the Visual Studio 2015 Solution (.sln) file. +3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. +## Run the sample -Build the sample ----------------- +The next steps depend on whether you just want to deploy the sample or you want to both deploy and run it. -1. Start Visual Studio 2015 and select **File \> Open \> Project/Solution**. -2. Go to the directory in which you unzipped the sample. Go to the directory named for the sample, and double-click the Microsoft Visual Studio Solution (.sln) file. -3. Press F7 or use **Build \> Build Solution** to build the sample. +### Deploying the sample +- Select Build > Deploy Solution. -Run the sample --------------- +### Deploying and running the sample -To debug the app and then run it, press F5 or use **Debug** \> **Start Debugging**. To run the app without debugging, press Ctrl+F5 or use **Debug** \> **Start Without Debugging**. +- To debug the sample and then run it, press F5 or select Debug > Start Debugging. To run the sample without debugging, press Ctrl+F5 or selectDebug > Start Without Debugging. diff --git a/orientation/readme.md b/orientation/readme.md index 44f5a878c9..7ecdd4c6a0 100644 --- a/orientation/readme.md +++ b/orientation/readme.md @@ -1,9 +1,6 @@ -OrientationSensor sample -======================== +# OrientationSensor sample -This sample shows how to use the [**Windows.Devices.Sensors.OrientationSensor**](http://msdn.microsoft.com/library/windows/apps/br206371) API. - -**Note**  This sample was created using one of the universal app templates available in Visual Studio. It shows how its solution is structured so it can run on both Windows 10 and Windows Phone 10. +This sample shows how to use the [Windows.Devices.Sensors.OrientationSensor](http://msdn.microsoft.com/library/windows/apps/br206371) API. This sample allows the user to view the rotation matrix and Quaternion values that reflect the current device orientation. You can choose one of these scenarios: @@ -11,59 +8,44 @@ This sample allows the user to view the rotation matrix and Quaternion values th - Poll orientation sensor readings - Sensor calibration -**Orientation sensor data events** +### Orientation sensor data events When you click the **Enable** button for the **Data Events** option, the app begins streaming sensor readings in real time. -**Poll orientation sensor readings** +### Poll orientation sensor readings When you click the **Enable** button for the **Polling** option, the app will retrieve the current sensor readings. -**Sensor calibration** +### Sensor calibration Allows the user to simulate sensor accuracy and demonstrates usage of the calibration bar. -**Note**  For Windows 8 app samples, download the [Windows 8 app samples pack](http://go.microsoft.com/fwlink/p/?LinkId=301698). The samples in the Windows 8 app samples pack will build and run only on Microsoft Visual Studio 2012. - -Related topics --------------- - -[Windows 8 app samples](http://go.microsoft.com/fwlink/p/?LinkID=227694) - -[**Windows.Devices.Sensors namespace**](http://msdn.microsoft.com/library/windows/apps/br206408) +## Related topics -Operating system requirements ------------------------------ +[Windows.Devices.Sensors namespace](http://msdn.microsoft.com/library/windows/apps/br206408) -Client +## System requirements -Windows 10 +**Client:** Windows 10 Technical Preview -Server +**Server:** Windows 10 Technical Preview -None supported +**Phone:** Windows 10 Technical Preview -Phone +## Build the sample -Windows Phone 10 +1. Start Microsoft Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. +2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++, C#, or JavaScript. Double-click the Visual Studio 2015 Solution (.sln) file. +3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. -Build the sample ----------------- - -1. Start Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. -2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++ or C\#. Double-click the Visual Studio 2015 Solution (.sln) file. -3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. - -Run the sample --------------- +## Run the sample The next steps depend on whether you just want to deploy the sample or you want to both deploy and run it. -**Deploying the sample** - -1. Select **Build** \> **Deploy Solution**. +### Deploying the sample -**Deploying and running the sample** +- Select Build > Deploy Solution. -1. To debug the sample and then run it, press F5 or select **Debug** \> **Start Debugging**. To run the sample without debugging, press Ctrl+F5 or select**Debug** \> **Start Without Debugging**. +### Deploying and running the sample +- To debug the sample and then run it, press F5 or select Debug > Start Debugging. To run the sample without debugging, press Ctrl+F5 or selectDebug > Start Without Debugging. diff --git a/proximitysensor/readme.md b/proximitysensor/readme.md index a7faa59115..edef9d9b22 100644 --- a/proximitysensor/readme.md +++ b/proximitysensor/readme.md @@ -1,57 +1,42 @@ -Proximity Sensor Sample -======================= +# Proximity Sensor Sample This sample demonstrates the use of the Windows.Devices.Sensors.ProximitySensor API. -**Note**  This sample was created using one of the universal app templates available in Visual Studio. It shows how its solution is structured so it can run on both Windows 10 and Windows Phone 10. - This sample allows the user to view the proximity detection reading as a boolean value. You can choose one of two scenarios: - Proximity sensor data events - Polling proximity sensor readings -**Proximity Sensor Data Events** +### Proximity Sensor Data Events When you choose the Enable button for the **Data Events** option, the app will begin displaying proximity sensor detection readings in real time. -**Polling Proximity Sensor Readings** +### Polling Proximity Sensor Readings When you choose the Get Data button for the **Polling** option, the app will retrieve the current sensor readings. -**Note**  For Windows 8 app samples, download the [Windows 8 app samples pack](http://go.microsoft.com/fwlink/p/?LinkId=301698). The samples in the Windows 8 app samples pack will build and run only on Microsoft Visual Studio 2012. - -Operating system requirements ------------------------------ - -Client +## System requirements -Windows 10 +**Client:** Windows 10 Technical Preview -Server +**Server:** Windows 10 Technical Preview -None supported +**Phone:** Windows 10 Technical Preview -Phone +## Build the sample -Windows Phone 10 +1. Start Microsoft Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. +2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++, C#, or JavaScript. Double-click the Visual Studio 2015 Solution (.sln) file. +3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. -Build the sample ----------------- - -1. Start Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. -2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++ or C\#. Double-click the Visual Studio 2015 Solution (.sln) file. -3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. - -Run the sample --------------- +## Run the sample The next steps depend on whether you just want to deploy the sample or you want to both deploy and run it. -**Deploying the sample** - -1. Select **Build** \> **Deploy Solution**. +### Deploying the sample -**Deploying and running the sample** +- Select Build > Deploy Solution. -1. To debug the sample and then run it, press F5 or select **Debug** \> **Start Debugging**. To run the sample without debugging, press Ctrl+F5 or select**Debug** \> **Start Without Debugging**. +### Deploying and running the sample +- To debug the sample and then run it, press F5 or select Debug > Start Debugging. To run the sample without debugging, press Ctrl+F5 or selectDebug > Start Without Debugging. diff --git a/relativeinclinometer/readme.md b/relativeinclinometer/readme.md index ec25ac7b5e..fcb93dc67e 100644 --- a/relativeinclinometer/readme.md +++ b/relativeinclinometer/readme.md @@ -1,56 +1,42 @@ -Relative Inclinometer Sensor Sample -=================================== +# Relative Inclinometer sensor sample This sample demonstrates use of the Windows.Devices.Sensors.Inclinometer API for the Relative Inclinometer sensor. -**Note**  This sample was created using one of the universal app templates available in Visual Studio. It shows how its solution is structured so it can run on both Windows 10 and Windows Phone 10. - This sample allows the user to view the angles of incline about the X-, Y-, and Z-axes for a 3-axis relative inclinometer. (The incline about the X-axis corresponds to the pitch value; the incline about the Y-axis correspond to the roll value; and the incline about the Z-axis corresponds to the yaw value.) You can choose one of three scenarios: - Relative inclinometer data events - Polling relative inclinometer readings -**Relative Inclinometer Data Events** +### Relative Inclinometer Data Events When you choose the Enable button for the **Data Events** option, the app will begin streaming relative inclinometer readings in real time. -**Polling Relative Inclinometer Readings** +### Polling Relative Inclinometer Readings When you choose the Enable button for the **Polling** option, the app will retrieve the current sensor readings. -**Note**  For Windows 8 app samples, download the [Windows 8 app samples pack](http://go.microsoft.com/fwlink/p/?LinkId=301698). The samples in the Windows 8 app samples pack will build and run only on Microsoft Visual Studio 2012. - -Operating system requirements ------------------------------ - -Client - -Windows 10 - -Server +## System requirements -None supported +**Client:** Windows 10 Technical Preview -Phone +**Server:** Windows 10 Technical Preview -Windows Phone 10 +**Phone:** Windows 10 Technical Preview -Build the sample ----------------- +## Build the sample -1. Start Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. -2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++ or C\#. Double-click the Visual Studio 2015 Solution (.sln) file. -3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. +1. Start Microsoft Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. +2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++, C#, or JavaScript. Double-click the Visual Studio 2015 Solution (.sln) file. +3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. -Run the sample --------------- +## Run the sample The next steps depend on whether you just want to deploy the sample or you want to both deploy and run it. -**Deploying the sample** +### Deploying the sample -1. Select **Build** \> **Deploy Solution**. +- Select Build > Deploy Solution. -**Deploying and running the sample** +### Deploying and running the sample -1. To debug the sample and then run it, press F5 or select **Debug** \> **Start Debugging**. To run the sample without debugging, press Ctrl+F5 or select**Debug** \> **Start Without Debugging**. +- To debug the sample and then run it, press F5 or select Debug > Start Debugging. To run the sample without debugging, press Ctrl+F5 or selectDebug > Start Without Debugging. diff --git a/relativeorientation/readme.md b/relativeorientation/readme.md index be03884bd5..0d17c2e190 100644 --- a/relativeorientation/readme.md +++ b/relativeorientation/readme.md @@ -1,56 +1,42 @@ -Relative Orientation Sensor Sample -=================================== +# Relative Orientation Sensor Sample This sample demonstrates use of the Windows.Devices.Sensors.Orientation API for the Relative Orientation sensor. -**Note**  This sample was created using one of the universal app templates available in Visual Studio. It shows how its solution is structured so it can run on both Windows 10 and Windows Phone 10. - This sample allows the user to view the rotation matrix and quaternion values that reflect the current device orientation. You can choose one of two scenarios: - Relative orientation data events - Polling relative orientation readings -**Relative Orientation Data Events** +### Relative Orientation Data Events When you choose the Enable button for the **Data Events** option, the app will begin streaming relative orientation readings in real time. -**Polling Relative Orientation Readings** +### Polling Relative Orientation Readings When you choose the Enable button for the **Polling** option, the app will retrieve the current sensor readings. -**Note**  For Windows 8 app samples, download the [Windows 8 app samples pack](http://go.microsoft.com/fwlink/p/?LinkId=301698). The samples in the Windows 8 app samples pack will build and run only on Microsoft Visual Studio 2012. - -Operating system requirements ------------------------------ - -Client - -Windows 10 - -Server +## System requirements -None supported +**Client:** Windows 10 Technical Preview -Phone +**Server:** Windows 10 Technical Preview -Windows Phone 10 +**Phone:** Windows 10 Technical Preview -Build the sample ----------------- +## Build the sample -1. Start Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. -2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++ or C\#. Double-click the Visual Studio 2015 Solution (.sln) file. -3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. +1. Start Microsoft Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. +2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++, C#, or JavaScript. Double-click the Visual Studio 2015 Solution (.sln) file. +3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. -Run the sample --------------- +## Run the sample The next steps depend on whether you just want to deploy the sample or you want to both deploy and run it. -**Deploying the sample** +### Deploying the sample -1. Select **Build** \> **Deploy Solution**. +- Select Build > Deploy Solution. -**Deploying and running the sample** +### Deploying and running the sample -1. To debug the sample and then run it, press F5 or select **Debug** \> **Start Debugging**. To run the sample without debugging, press Ctrl+F5 or select**Debug** \> **Start Without Debugging**. +- To debug the sample and then run it, press F5 or select Debug > Start Debugging. To run the sample without debugging, press Ctrl+F5 or selectDebug > Start Without Debugging. diff --git a/simpleorientation/readme.md b/simpleorientation/readme.md index 5f507339c7..42cd9b57e0 100644 --- a/simpleorientation/readme.md +++ b/simpleorientation/readme.md @@ -1,57 +1,42 @@ -Relative Orientation Sensor Sample -================================== +# Relative Orientation Sensor Sample This sample demonstrates the use of the Windows.Devices.Sensors.SimpleOrientationSensor API for a simple device orientation sensor. -**Note**  This sample was created using one of the universal app templates available in Visual Studio. It shows how its solution is structured so it can run on both Windows 10 and Windows Phone 10. - This sample allows the user to view the orientation values that reflect the simple device orientation. You can choose one of two scenarios: - Orientation sensor data events - Polling orientation sensor readings -**Simple Orientation Sensor Data Events** +### Simple Orientation Sensor Data Events When you choose the Enable button for the **Data Events** option, the app will begin displaying sensor readings in real time. -**Polling Simple Orientation Sensor Readings** +### Polling Simple Orientation Sensor Readings When you choose the Enable button for the **Polling** option, the app will retrieve the current sensor readings. -**Note**  For Windows 8 app samples, download the [Windows 8 app samples pack](http://go.microsoft.com/fwlink/p/?LinkId=301698). The samples in the Windows 8 app samples pack will build and run only on Microsoft Visual Studio 2012. - -Operating system requirements ------------------------------ - -Client +## System requirements -Windows 10 +**Client:** Windows 10 Technical Preview -Server +**Server:** Windows 10 Technical Preview -None supported +**Phone:** Windows 10 Technical Preview -Phone +## Build the sample -Windows Phone 10 +1. Start Microsoft Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. +2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++, C#, or JavaScript. Double-click the Visual Studio 2015 Solution (.sln) file. +3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. -Build the sample ----------------- - -1. Start Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. -2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++ or C\#. Double-click the Visual Studio 2015 Solution (.sln) file. -3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. - -Run the sample --------------- +## Run the sample The next steps depend on whether you just want to deploy the sample or you want to both deploy and run it. -**Deploying the sample** - -1. Select **Build** \> **Deploy Solution**. +### Deploying the sample -**Deploying and running the sample** +- Select Build > Deploy Solution. -1. To debug the sample and then run it, press F5 or select **Debug** \> **Start Debugging**. To run the sample without debugging, press Ctrl+F5 or select**Debug** \> **Start Without Debugging**. +### Deploying and running the sample +- To debug the sample and then run it, press F5 or select Debug > Start Debugging. To run the sample without debugging, press Ctrl+F5 or selectDebug > Start Without Debugging. diff --git a/smssendandreceive/readme.md b/smssendandreceive/readme.md index 470b1f6e5c..dbc6f5975c 100644 --- a/smssendandreceive/readme.md +++ b/smssendandreceive/readme.md @@ -1,25 +1,34 @@ -This sample demonstrates ... +# SMS send and receive sample -Specifically, this sample covers: +This sample demonstrates: -- This sample shows how to use the Mobile Broadband SMS API (Windows.Devices.Sms). It shows how to send text message. -- This sample also demonstrates how set filter rules for registering with background infrastructure and then receiving the sms based on filter rules. +- How to use the Mobile Broadband SMS API (Windows.Devices.Sms). It shows how to send text message. +- How to set filter rules for registering with background infrastructure and then receiving the SMS based on filter rules. -Related topics --------------- +## System requirements -**Samples** +**Client:** Windows 10 Technical Preview -[Sample 1](http://code.microsoft.com/windowsapps) +**Server:** Windows 10 Technical Preview -**Reference** +**Phone:** Windows 10 Technical Preview - -[API 1](http://msdn.microsoft.com/library/windows/apps/) -[API 2](http://msdn.microsoft.com/library/windows/apps/) +## Build the sample -System requirements ------------------------------ - +1. Start Microsoft Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. +2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++, C#, or JavaScript. Double-click the Visual Studio 2015 Solution (.sln) file. +3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. + +## Run the sample + +The next steps depend on whether you just want to deploy the sample or you want to both deploy and run it. + +### Deploying the sample + +- Select Build > Deploy Solution. + +### Deploying and running the sample + +- To debug the sample and then run it, press F5 or select Debug > Start Debugging. To run the sample without debugging, press Ctrl+F5 or selectDebug > Start Without Debugging. diff --git a/speechandtts/readme.md b/speechandtts/readme.md index 687aa75f82..77fd0bff34 100644 --- a/speechandtts/readme.md +++ b/speechandtts/readme.md @@ -1,3 +1,5 @@ +# Speech and text-to-speech sample + This sample demonstrates the usage of Speech Recognition and Speech Synthesis (Text to speech) within Universal Applications Specifically, this sample covers: @@ -9,20 +11,41 @@ Specifically, this sample covers: - Synthesis using SSML files - Synthesis voice configuration -Related topics --------------- - -**Reference** +## Related topics - [Speech Recognition](https://msdn.microsoft.com/en-us/library/windows.media.speechrecognition.aspx) - [Speech Synthesis](https://msdn.microsoft.com/en-us/library/windows/apps/windows.media.speechsynthesis.aspx) -System requirements ------------------------------ -Speech recognition requires an appropriate audio input device. - - -Known Issues ------------------------------ -- RecognizeWithUIAsync is currently not available on Windows Desktop, and will be available in later releases of Windows 10. -- SpeechRecognition fails to initialize in the Windows Phone emulator. It does work on physical Windows Phone devices. \ No newline at end of file +## System requirements + +**Hardware:** Speech recognition requires an appropriate audio input device. + +**Client:** Windows 10 Technical Preview + +**Server:** Windows 10 Technical Preview + +**Phone:** Windows 10 Technical Preview + +**Known Issues:** + +- RecognizeWithUIAsync is currently not available on Windows Desktop, and will be available in later releases of Windows 10. +- SpeechRecognition fails to initialize in the Windows Phone emulator. It does work on physical Windows Phone devices. + +## Build the sample + +1. Start Microsoft Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. +2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++, C#, or JavaScript. Double-click the Visual Studio 2015 Solution (.sln) file. +3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. + +## Run the sample + +The next steps depend on whether you just want to deploy the sample or you want to both deploy and run it. + +### Deploying the sample + +- Select Build > Deploy Solution. + +### Deploying and running the sample + +- To debug the sample and then run it, press F5 or select Debug > Start Debugging. To run the sample without debugging, press Ctrl+F5 or selectDebug > Start Without Debugging. + \ No newline at end of file diff --git a/streamsocket/readme.md b/streamsocket/readme.md index 9cb982e5fb..e828447b99 100644 --- a/streamsocket/readme.md +++ b/streamsocket/readme.md @@ -1,10 +1,7 @@ -StreamSocket sample -=================== +# StreamSocket sample This sample shows you how to a use stream (TCP) socket to send and receive data using the [**StreamSocket**](http://msdn.microsoft.com/library/windows/apps/br226882) and related classes in the [**Windows.Networking.Sockets**](http://msdn.microsoft.com/library/windows/apps/br226960) namespace in your Windows Runtime app. -**Note**  This sample was created using one of the universal app templates available in Visual Studio. It shows how its solution is structured so it can run on both Windows 8.1 and Windows Phone 8.1. For more info about how to build apps that target Windows and Windows Phone with Visual Studio, see [Build apps that target Windows and Windows Phone 8.1 by using Visual Studio](http://msdn.microsoft.com/library/windows/apps/dn609832). - The client component of the sample creates a TCP socket to make a network connection, uses the socket to send data, and closes the socket. The server component sets up a TCP listener that provides a connected socket for every incoming network connection, uses the socket to receive data from the client, and closes the socket. This sample is provided in the JavaScript, C\#, VB, and C++ programming languages. The client component of the sample demonstrates the following features: @@ -49,16 +46,31 @@ For more information on network capabilities, see [How to set network capabiliti **Note**  Network communications using an IP loopback address cannot normally be used for interprocess communication between a Windows Runtime app and a different process (a different Windows Runtime app or a desktop app) because this is restricted by network isolation. Network communication using an IP loopback address is allowed within the same process for communication purposes in a Windows Runtime app. For more information, see [How to set network capabilities](http://msdn.microsoft.com/library/windows/apps/hh770532). -To obtain an evaluation copy of Windows 8.1, go to [Windows 8.1](http://go.microsoft.com/fwlink/p/?linkid=301696). +## Related topics + +### Reference -To obtain an evaluation copy of Microsoft Visual Studio 2013 Update 2, go to [Microsoft Visual Studio 2013](http://go.microsoft.com/fwlink/p/?linkid=301697). +[**StreamSocket**](http://msdn.microsoft.com/library/windows/apps/br226882) -**Note**  For Windows 8 app samples, download the [Windows 8 app samples pack](http://go.microsoft.com/fwlink/p/?LinkId=301698). The samples in the Windows 8 app samples pack will build and run only on Microsoft Visual Studio 2012. +[**StreamSocketListener**](http://msdn.microsoft.com/library/windows/apps/br226906) -Related topics --------------- +[**Windows.Networking**](http://msdn.microsoft.com/library/windows/apps/br207124) + +[**Windows.Networking.Sockets**](http://msdn.microsoft.com/library/windows/apps/br226960) -**Other - C\#/VB/C++ and XAML** +[**Windows.Storage.Streams.DataReader**](http://msdn.microsoft.com/library/windows/apps/br208119) + +[**Windows.Storage.Streams.DataWriter**](http://msdn.microsoft.com/library/windows/apps/br208154) + +### Samples + +[DatagramSocket sample](http://go.microsoft.com/fwlink/p/?linkid=258328) + +[ControlChannelTrigger TCP socket sample](http://go.microsoft.com/fwlink/p/?linkid=243039) + +[Windows 8 app samples](http://go.microsoft.com/fwlink/p/?LinkID=227694) + +### Other - C\#/VB/C++ and XAML [Adding support for networking (XAML)](http://msdn.microsoft.com/library/windows/apps/hh452751) @@ -78,7 +90,7 @@ Related topics [Troubleshooting and debugging network connections](http://msdn.microsoft.com/library/windows/apps/hh770534) -**Other - JavaScript and HTML** +### Other - JavaScript and HTML [Adding support for networking (HTML)](http://msdn.microsoft.com/library/windows/apps/hh452752) @@ -98,75 +110,21 @@ Related topics [Troubleshooting and debugging network connections](http://msdn.microsoft.com/library/windows/apps/hh770534) -**Reference** - -[**StreamSocket**](http://msdn.microsoft.com/library/windows/apps/br226882) - -[**StreamSocketListener**](http://msdn.microsoft.com/library/windows/apps/br226906) - -[**Windows.Networking**](http://msdn.microsoft.com/library/windows/apps/br207124) - -[**Windows.Networking.Sockets**](http://msdn.microsoft.com/library/windows/apps/br226960) - -[**Windows.Storage.Streams.DataReader**](http://msdn.microsoft.com/library/windows/apps/br208119) - -[**Windows.Storage.Streams.DataWriter**](http://msdn.microsoft.com/library/windows/apps/br208154) - -**Samples** - -[DatagramSocket sample](http://go.microsoft.com/fwlink/p/?linkid=258328) - -[ControlChannelTrigger TCP socket sample](http://go.microsoft.com/fwlink/p/?linkid=243039) - -[Windows 8 app samples](http://go.microsoft.com/fwlink/p/?LinkID=227694) - -Operating system requirements ------------------------------ - -Client - -Windows 8.1 - -Server - -Windows Server 2012 R2 - -Phone - -Windows Phone 8.1 - -Build the sample ----------------- - -1. Start Visual Studio 2013 Update 2 and select **File** \> **Open** \> **Project/Solution**. -2. Go to the directory to which you unzipped the sample. Go to the directory named for the sample, and double-click the Visual Studio 2013 Update 2 Solution (.sln) file. -3. Follow the steps for the version of the sample you want: - - To build the Windows version of the sample: - - 1. Select **StreamSocket.Windows** in **Solution Explorer**. - 2. Press Ctrl+Shift+B, or use **Build** \> **Build Solution**, or use **Build** \> **Build StreamSocket.Windows**. - - To build the Windows Phone version of the sample: - - 1. Select **StreamSocket.WindowsPhone** in **Solution Explorer**. - 2. Press Ctrl+Shift+B or use **Build** \> **Build Solution** or use **Build** \> **Build StreamSocket.WindowsPhone**. - -Run the sample --------------- +## System requirements -The next steps depend on whether you just want to deploy the sample or you want to both deploy and run it. +**Client:** Windows 10 Technical Preview -**Deploying the sample** +**Server:** Windows 10 Technical Preview -- To deploy the built Windows version of the sample: +**Phone:** Windows 10 Technical Preview - 1. Select **StreamSocket.Windows** in **Solution Explorer**. - 2. Use **Build** \> **Deploy Solution** or **Build** \> **Deploy StreamSocket.Windows**. -- To deploy the built Windows Phone version of the sample: +## Build the sample - 1. Select **StreamSocket.WindowsPhone** in **Solution Explorer**. - 2. Use **Build** \> **Deploy Solution** or **Build** \> **Deploy StreamSocket.WindowsPhone**. +1. Start Microsoft Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. +2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++, C#, or JavaScript. Double-click the Visual Studio 2015 Solution (.sln) file. +3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. -**Deploying and running the Windows version of the sample** +### Deploying and running the Windows version of the sample For the app to attempt a socket connection using SSL to a web server at port 443 (HTTPS) and view the server certificate, this sample requires that a web server is available that supports HTTPS. The web server must be started before the app is run. The sample includes a PowerShell script that will install and enable IIS on a local computer, generate a self-signed, untrusted certificate, and enable HTTPS connections. The easiest way to run the sample is to use the provided web server scripts. @@ -221,7 +179,7 @@ To configure the sample for use with a web server different than IIS not using l 1. Right-click **StreamSocket.Windows** in **Solution Explorer** and select **Set as StartUp Project**. 2. To debug the sample and then run it, press F5 or use **Debug** \> **Start Debugging**. To run the sample without debugging, press Ctrl+F5 or use **Debug** \> **Start Without Debugging**. -**Deploying and running the Windows Phone version of the sample** +### Deploying and running the Windows Phone version of the sample IIS is not available on Windows Phone. For the app to attempt a socket connection using SSL to a web server, there are two options: diff --git a/xml/readme.md b/xml/readme.md index 657bbbe356..2884e05bac 100644 --- a/xml/readme.md +++ b/xml/readme.md @@ -1,27 +1,47 @@ -This sample demonstrates common XML API use scenarios for the ***Windows.Data.Xml.Dom*** and ***Windows.Data.Xml.Xsl*** namespaces in the Windows Runtime. +# XML sample + +This sample demonstrates common XML API use scenarios for the **Windows.Data.Xml.Dom** and **Windows.Data.Xml.Xsl** namespaces in the Windows Runtime. Specifically, this sample covers: -- Scenario 1: Loading an RSS template XML file asynchronously and adding a CData section. The asynchronous loading is accomplished by using the *XmlDocument.loadFromFileAsync* method from the *Windows.Data.Xml.Dom* namespace. The *XmlDocument.CreateCDataSection* method is used to add the CDATA section to the RSS file. +- **Scenario 1:** Loading an RSS template XML file asynchronously and adding a CData section. The asynchronous loading is accomplished by using the **XmlDocument.loadFromFileAsync** method from the **Windows.Data.Xml.Dom** namespace. The **XmlDocument.CreateCDataSection** method is used to add the CDATA section to the RSS file. -- Scenario 2: Traversing a Document Object Model (DOM) tree to update the data and save it to a file. When the user presses the **"Mark Hot Products"** button, an XPath query is used to select products from an XML file, which have an attribute named "Sell10day" that exceeds the attribute named "InStore". The "Sell10Day" value represents the quantity sold in the last ten days. These products are marked "hot" by setting the "hot" attribute for the product to 1. When the user presses the **"Save"** button, the *XmlDocument.saveToFileAsync* method is used to save the XML file containing the products list. +- **Scenario 2:** Traversing a Document Object Model (DOM) tree to update the data and save it to a file. When the user presses the **"Mark Hot Products"** button, an XPath query is used to select products from an XML file, which have an attribute named "Sell10day" that exceeds the attribute named "InStore". The "Sell10Day" value represents the quantity sold in the last ten days. These products are marked "hot" by setting the "hot" attribute for the product to 1. When the user presses the **"Save"** button, the **XmlDocument.saveToFileAsync** method is used to save the XML file containing the products list. -- Scenario 3: Using the security settings prohibitDTD and resolveExternals when loading an XML file. prohibitDTD will prevent DTD use in a XML file. A large number of DTD entity references can cause an application to become unresponsive when loading and parsing an XML file. resolveExternals determines whether external references can be resolved during parsing. For this scenario, a user chooses a combination of these two security settings, which are properties on the *XmlLoadSettings* class used with method *XmlDocument.LoadFromFileAsync* and *XmlDocument.LoadXmlFromBuffer*. The user presses the **"Load XML From File"** button to view the resulting XML by *LoadFromFileAsync* or **"Load XML From Buffer"** button to view the resulting XML by *LoadXmlFromBuffer*. +- **Scenario 3:** Using the security settings prohibitDTD and resolveExternals when loading an XML file. prohibitDTD will prevent DTD use in a XML file. A large number of DTD entity references can cause an application to become unresponsive when loading and parsing an XML file. resolveExternals determines whether external references can be resolved during parsing. For this scenario, a user chooses a combination of these two security settings, which are properties on the **XmlLoadSettings** class used with method **XmlDocument.LoadFromFileAsync** and **XmlDocument.LoadXmlFromBuffer**. The user presses the **"Load XML From File"** button to view the resulting XML by **LoadFromFileAsync** or **"Load XML From Buffer"** button to view the resulting XML by **LoadXmlFromBuffer**. -- Scenario 4: Using an XPath with the XML API for the Windows Runtime to select and filter data in a DOM tree. When a user presses the **"Show Anniversary Gift"** button, the scenario constructs an array of XPath queries used by the *XmlDocument.SelectNodes* method against an XML file to determine an anniversary gift for each employee based on the year the employee started the job. Employees with between 1 and 4 years on the job receive a gift card. Employees with between 5 and 9 years on the job receive an XBOX. Employees with 10 or more years on the job receive a Windows Phone. +- **Scenario 4:** Using an XPath with the XML API for the Windows Runtime to select and filter data in a DOM tree. When a user presses the **"Show Anniversary Gift"** button, the scenario constructs an array of XPath queries used by the **XmlDocument.SelectNodes** method against an XML file to determine an anniversary gift for each employee based on the year the employee started the job. Employees with between 1 and 4 years on the job receive a gift card. Employees with between 5 and 9 years on the job receive an XBOX. Employees with 10 or more years on the job receive a Windows Phone. -- Scenario 5: Using eXtensible Stylesheet Language Transformations (XSLT) with the XML APIs to transform an XML file into an HTML webpage. The source XML and XSL are loaded during initialization of the scenario. The XSL transform is applied when the user presses the **"TransformToString"** and **"TransformToDocument"** button. The Source XML and Source XSL can both be modified during runtime to see different results when applying an XSL transform. The transform is applied using the *XsltProcessor* class from the *Windows.Data.Xml.Xsl* namespace. +- **Scenario 5:** Using eXtensible Stylesheet Language Transformations (XSLT) with the XML APIs to transform an XML file into an HTML webpage. The source XML and XSL are loaded during initialization of the scenario. The XSL transform is applied when the user presses the **"TransformToString"** and **"TransformToDocument"** button. The Source XML and Source XSL can both be modified during runtime to see different results when applying an XSL transform. The transform is applied using the **XsltProcessor** class from the **Windows.Data.Xml.Xsl** namespace. -Related topics --------------- +## Related topics - [Windows.Data.Xml.Dom.XmlDocument](https://msdn.microsoft.com/library/windows/apps/br206173) [Windows.Data.Xml.Xsl.XsltProcessor](https://msdn.microsoft.com/en-us/library/windows/apps/windows.data.xml.xsl.xsltprocessor.aspx) -System requirements ------------------------------ - -- Min OS: win10, w10srv -- Supported IDE: VisualStudio2015 \ No newline at end of file +## System requirements + +**Client:** Windows 10 Technical Preview + +**Server:** Windows 10 Technical Preview + +**Phone:** Windows 10 Technical Preview + +## Build the sample + +1. Start Microsoft Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. +2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++, C#, or JavaScript. Double-click the Visual Studio 2015 Solution (.sln) file. +3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. + +## Run the sample + +The next steps depend on whether you just want to deploy the sample or you want to both deploy and run it. + +### Deploying the sample + +- Select Build > Deploy Solution. + +### Deploying and running the sample + +- To debug the sample and then run it, press F5 or select Debug > Start Debugging. To run the sample without debugging, press Ctrl+F5 or selectDebug > Start Without Debugging. diff --git a/xmllite/readme.md b/xmllite/readme.md index ff5ffe90b4..9e2a0eff01 100644 --- a/xmllite/readme.md +++ b/xmllite/readme.md @@ -1,3 +1,5 @@ +# XmlLite sample + This sample demonstrates how to use **XmlLite** Reader and Writer. Specifically, this sample covers: @@ -6,16 +8,34 @@ Specifically, this sample covers: - Scenario 2: Use ***XmlWriter*** to write different types of node to a file. - Scenario 3: Use ***XmlWriterLite*** to write different types of node to a file. -Related topics --------------- +## Related topics - [IXmlReader](https://msdn.microsoft.com/en-us/library/windows/desktop/ms752743(v=vs.85).aspx) [IXmlWriter](https://msdn.microsoft.com/en-us/library/windows/desktop/ms752860(v=vs.85).aspx) -System requirements ------------------------------ - -- Min OS: win10, w10srv -- Supported IDE: VisualStudio2015 \ No newline at end of file +## System requirements + +**Client:** Windows 10 Technical Preview + +**Server:** Windows 10 Technical Preview + +**Phone:** Windows 10 Technical Preview + +## Build the sample + +1. Start Microsoft Visual Studio 2015 and select **File** \> **Open** \> **Project/Solution**. +2. Go to the directory to which you unzipped the sample. Then go to the subdirectory containing the sample in the language you desire - either C++, C#, or JavaScript. Double-click the Visual Studio 2015 Solution (.sln) file. +3. Press Ctrl+Shift+B, or select **Build** \> **Build Solution**. + +## Run the sample + +The next steps depend on whether you just want to deploy the sample or you want to both deploy and run it. + +### Deploying the sample + +- Select Build > Deploy Solution. + +### Deploying and running the sample + +- To debug the sample and then run it, press F5 or select Debug > Start Debugging. To run the sample without debugging, press Ctrl+F5 or selectDebug > Start Without Debugging.