Skip to content

Commit

Permalink
readme scrub
Browse files Browse the repository at this point in the history 
scrubbed readme files of Win8.1/VS2013 references, and updated
boilerplate sections
  • Loading branch information
@KarlErickson
KarlErickson committed Mar 20, 2015
1 parent fe076c7 commit b0ea91e
Show file tree
Hide file tree
Showing 24 changed files with 497 additions and 779 deletions.
55 changes: 20 additions & 35 deletions accelerometer/readme.md
View file
Original file line number Diff line number Diff line change
@@ -1,37 +1,31 @@
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
- Accelerometer shake events
- 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)

Expand All @@ -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.
50 changes: 18 additions & 32 deletions activitysensor/readme.md
View file
Original file line number Diff line number Diff line change
@@ -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:

Expand All @@ -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.
44 changes: 15 additions & 29 deletions altimeter/readme.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.
86 changes: 19 additions & 67 deletions backgroundtransfer/readme.md
View file
Original file line number Diff line number Diff line change
@@ -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.
Expand Down Expand Up @@ -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)

Expand All @@ -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.

Expand Down Expand Up @@ -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:

Expand Down
Loading

0 comments on commit b0ea91e

Please sign in to comment.