Skip to content

Commit 27a5517

Browse files
authored
Merge pull request #186227 from ShawnJackson/setup-platform
edit pass: setup-platform
2 parents c09da44 + a4740b2 commit 27a5517

23 files changed

+302
-265
lines changed

articles/cognitive-services/Speech-Service/includes/quickstarts/platform/cpp-linux.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: 'Quickstart: Speech SDK C++ (Linux) platform setup - Speech service'
33
titleSuffix: Azure Cognitive Services
4-
description: Use this guide to set up your platform for C++ on Linux with the Speech service SDK.
4+
description: Use this guide to set up your platform for C++ on Linux by using the Speech SDK.
55
services: cognitive-services
66
author: markamos
77
manager: nitinme
@@ -12,18 +12,17 @@ ms.date: 10/15/2020
1212
ms.author: eur
1313
---
1414

15-
16-
This guide shows how to install the [Speech SDK](~/articles/cognitive-services/speech-service/speech-sdk.md) for Linux
15+
This guide shows how to install the [Speech SDK](~/articles/cognitive-services/speech-service/speech-sdk.md) for Linux.
1716

1817
[!INCLUDE [License Notice](~/includes/cognitive-services-speech-service-license-notice.md)]
1918

2019
## System requirements
2120

22-
Linux; see the list of [supported Linux distributions and target architectures](~/articles/cognitive-services/speech-service/speech-sdk.md).
21+
See the [list of supported Linux distributions and target architectures](~/articles/cognitive-services/speech-service/speech-sdk.md).
2322

2423
## Prerequisites
2524

26-
See [system requirements and setup instructions](~/articles/cognitive-services/speech-service/speech-sdk.md#get-the-speech-sdk) on Linux.
25+
See the [system requirements and setup instructions](~/articles/cognitive-services/speech-service/speech-sdk.md#get-the-speech-sdk) for Linux.
2726

2827
[!INCLUDE [linux-install-sdk](linux-install-sdk.md)]
2928

articles/cognitive-services/Speech-Service/includes/quickstarts/platform/cpp-macos.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: 'Quickstart: Speech SDK C++ (macOS) platform setup - Speech service'
33
titleSuffix: Azure Cognitive Services
4-
description: Use this guide to set up your platform for C++ on macOS with the Speech service SDK.
4+
description: Use this guide to set up your platform for C++ on macOS by using the Speech SDK.
55
services: cognitive-services
66
author: markamos
77
manager: nitinme
@@ -12,29 +12,31 @@ ms.date: 10/15/2020
1212
ms.author: eur
1313
---
1414

15-
This guide shows how to install the [Speech SDK](~/articles/cognitive-services/speech-service/speech-sdk.md) for C++ on macOS 10.14 and above.
15+
This guide shows how to install the [Speech SDK](~/articles/cognitive-services/speech-service/speech-sdk.md) for C++ on macOS 10.14 and later.
1616

1717
[!INCLUDE [License Notice](~/includes/cognitive-services-speech-service-license-notice.md)]
1818

1919
## System requirements
2020

21-
macOS 10.14 and above
21+
You must have macOS 10.14 or later.
2222

23-
## Install Speech SDK
23+
## Install the Speech SDK
2424

25-
1. Choose a directory to which the Speech SDK files should be extracted, and set the `SPEECHSDK_ROOT` environment variable to point to that directory. This variable makes it easy to refer to the directory in future commands. For example, if you want to use the directory `speechsdk` in your home directory, use a command like the following:
25+
1. Choose a directory to which the Speech SDK files should be extracted, and set the `SPEECHSDK_ROOT` environment variable to point to that directory. This variable makes it easy to refer to the directory in future commands.
26+
27+
For example, if you want to use the directory `speechsdk` in your home directory, use a command like the following:
2628

2729
```sh
2830
export SPEECHSDK_ROOT="$HOME/speechsdk"
2931
```
3032

31-
1. Create the directory if it doesn't exist yet.
33+
1. Create the directory if it doesn't exist yet:
3234

3335
```sh
3436
mkdir -p "$SPEECHSDK_ROOT"
3537
```
3638

37-
1. Download and extract the `.zip` archive containing the Speech SDK xcframework:
39+
1. Download and extract the .zip archive that contains the Speech SDK XCFramework:
3840

3941
```sh
4042
wget -O SpeechSDK-macOS.zip https://aka.ms/csspeech/macosbinary
@@ -47,7 +49,7 @@ macOS 10.14 and above
4749
ls -l "$SPEECHSDK_ROOT"
4850
```
4951

50-
The directory listing should contain the third-party notice and license files, as well as a `MicrosoftCognitiveServicesSpeech.xcframework` directory.
52+
The directory listing should contain the third-party notice, license files, and a `MicrosoftCognitiveServicesSpeech.xcframework` directory.
5153

5254
## Next steps
5355

articles/cognitive-services/Speech-Service/includes/quickstarts/platform/cpp-windows.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: 'Quickstart: Speech SDK for C++ (Windows) platform setup - Speech service'
33
titleSuffix: Azure Cognitive Services
4-
description: Use this guide to set up your platform for C++ on Windows Desktop with the Speech service SDK.
4+
description: Use this guide to set up your platform for C++ on Windows desktop operating systems by using the Speech SDK.
55
services: cognitive-services
66
author: markamos
77
manager: nitinme
@@ -13,16 +13,16 @@ ms.author: eur
1313
ms.custom: ignite-fall-2021
1414
---
1515

16-
This guide shows how to install the [Speech SDK](~/articles/cognitive-services/speech-service/speech-sdk.md) for C++ on Windows Desktop.
16+
This guide shows how to install the [Speech SDK](~/articles/cognitive-services/speech-service/speech-sdk.md) for C++ on Windows desktop operating systems.
1717

1818
[!INCLUDE [License Notice](~/includes/cognitive-services-speech-service-license-notice.md)]
1919

2020
## Prerequisites
2121

2222
This quickstart requires:
2323

24-
* On Windows, you need the [Microsoft Visual C++ Redistributable for Visual Studio 2019](https://support.microsoft.com/topic/the-latest-supported-visual-c-downloads-2647da03-1eea-4433-9aff-95f26a218cc0) for your platform. Installing this for the first time may require a restart.
25-
* [Visual Studio 2019](https://visualstudio.microsoft.com/downloads/)
24+
* [Microsoft Visual C++ Redistributable for Visual Studio 2019](https://support.microsoft.com/topic/the-latest-supported-visual-c-downloads-2647da03-1eea-4433-9aff-95f26a218cc0) for the Windows platform. Installing it for the first time might require a restart.
25+
* [Visual Studio 2019](https://visualstudio.microsoft.com/downloads/).
2626

2727
## Create a Visual Studio project and install the Speech SDK
2828

articles/cognitive-services/Speech-Service/includes/quickstarts/platform/csharp-dotnet-windows.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: 'Quickstart: Speech SDK for .NET Framework (Windows) platform setup - Speech service'
33
titleSuffix: Azure Cognitive Services
4-
description: 'Use this guide to set up your platform for C# under .NET Framework for Windows with the Speech service SDK.'
4+
description: 'Use this guide to set up your platform for C# under the .NET Framework for Windows with the Speech service SDK.'
55
services: cognitive-services
66
author: markamos
77
manager: nitinme
@@ -13,70 +13,70 @@ ms.author: eur
1313
ms.custom: devx-track-dotnet, ignite-fall-2021
1414
---
1515

16-
This guide shows how to install the [Speech SDK](~/articles/cognitive-services/speech-service/speech-sdk.md) for .NET Framework (Windows). If you just want the package name to get started on your own, run `Install-Package Microsoft.CognitiveServices.Speech` in the NuGet console.
16+
This guide shows how to install the [Speech SDK](~/articles/cognitive-services/speech-service/speech-sdk.md) for the .NET Framework (Windows). If you just want the package name to get started on your own, run `Install-Package Microsoft.CognitiveServices.Speech` in the NuGet console.
1717

1818
[!INCLUDE [License Notice](~/includes/cognitive-services-speech-service-license-notice.md)]
1919

2020
## Prerequisites
2121

2222
This quickstart requires:
2323

24-
* On Windows, you need the [Microsoft Visual C++ Redistributable for Visual Studio 2019](https://support.microsoft.com/topic/the-latest-supported-visual-c-downloads-2647da03-1eea-4433-9aff-95f26a218cc0) for your platform. Installing this for the first time may require a restart.
25-
* [Visual Studio 2019](https://visualstudio.microsoft.com/downloads/)
24+
* [Microsoft Visual C++ Redistributable for Visual Studio 2019](https://support.microsoft.com/topic/the-latest-supported-visual-c-downloads-2647da03-1eea-4433-9aff-95f26a218cc0) for the Windows platform. Installing it for the first time might require a restart.
25+
* [Visual Studio 2019](https://visualstudio.microsoft.com/downloads/).
2626

2727
## Create a Visual Studio project and install the Speech SDK
2828

29-
You'll need to install the [Speech SDK NuGet package](https://aka.ms/csspeech/nuget) so you can reference it in your code. To do that, you may first need to create a **helloworld** project. If you already have a project with the **.NET desktop development** workload available, you can use that project and skip to [Use NuGet Package Manager to install the Speech SDK](#use-nuget-package-manager-to-install-the-speech-sdk).
29+
You need to install the [Speech SDK NuGet package](https://aka.ms/csspeech/nuget) so you can reference it in your code. To do that, you might first need to create a **helloworld** project. If you already have a project with the **.NET desktop development** workload available, you can use that project and skip to [Use NuGet Package Manager to install the Speech SDK](#use-nuget-package-manager-to-install-the-speech-sdk).
3030

31-
### Create helloworld project
31+
### Create a helloworld project
3232

3333
1. Open Visual Studio 2019.
3434

35-
1. In the Start window, select **Create a new project**.
35+
1. In the **Start** window, select **Create a new project**.
3636

3737
1. In the **Create a new project** window, choose **Console App (.NET Framework)**, and then select **Next**.
3838

39-
1. In the **Configure your new project** window, enter *helloworld* in **Project name**, choose or create the directory path in **Location**, and then select **Create**.
39+
1. In the **Configure your new project** window, enter **helloworld** in **Project name**, choose or create the directory path in **Location**, and then select **Create**.
4040

41-
1. From the Visual Studio menu bar, select **Tools** > **Get Tools and Features**, which opens Visual Studio Installer and displays the **Modifying** dialog box.
41+
1. From the Visual Studio menu bar, select **Tools** > **Get Tools and Features**. This step opens Visual Studio Installer and displays the **Modifying** dialog.
4242

43-
1. Check whether the **.NET desktop development** workload is available. If the workload hasn't been installed, select the check box next to it, and then select **Modify** to start the installation. It may take a few minutes to download and install.
43+
1. Check whether the **.NET desktop development** workload is available. If the workload hasn't been installed, select the check box next to it, and then select **Modify** to start the installation. It might take a few minutes to download and install.
4444

45-
If the check box next to **.NET desktop development** is already selected, select **Close** to exit the dialog box.
45+
If the check box next to **.NET desktop development** is already selected, select **Close** to close the dialog.
4646

47-
![Enable .NET desktop development](~/articles/cognitive-services/speech-service/media/sdk/vs-enable-net-desktop-workload.png)
47+
![Screenshot that shows enabling .NET desktop development.](~/articles/cognitive-services/speech-service/media/sdk/vs-enable-net-desktop-workload.png)
4848

4949
1. Close Visual Studio Installer.
5050

5151
### Use NuGet Package Manager to install the Speech SDK
5252

53-
1. In the Solution Explorer, right-click the **helloworld** project, and then select **Manage NuGet Packages** to show the NuGet Package Manager.
53+
1. In Solution Explorer, right-click the **helloworld** project, and then select **Manage NuGet Packages** to show NuGet Package Manager.
5454

55-
![NuGet Package Manager](~/articles/cognitive-services/speech-service/media/sdk/vs-nuget-package-manager.png)
55+
1. In the upper-right corner, find the **Package Source** drop-down box, and make sure that **nuget.org** is selected.
5656

57-
1. In the upper-right corner, find the **Package Source** drop-down box, and make sure that **`nuget.org`** is selected.
57+
![Screenshot that shows NuGet Package Manager.](~/articles/cognitive-services/speech-service/media/sdk/vs-nuget-package-manager.png)
5858

5959
1. In the upper-left corner, select **Browse**.
6060

61-
1. In the search box, type *Microsoft.CognitiveServices.Speech* and select **Enter**.
61+
1. In the search box, type **Microsoft.CognitiveServices.Speech** and select **Enter**.
6262

6363
1. From the search results, select the **Microsoft.CognitiveServices.Speech** package, and then select **Install** to install the latest stable version.
6464

65-
![Install Microsoft.CognitiveServices.Speech NuGet package](~/articles/cognitive-services/speech-service/media/sdk/qs-csharp-dotnet-windows-03-nuget-install-1.0.0.png)
65+
![Screenshot that shows installing the Microsoft.CognitiveServices.Speech NuGet package.](~/articles/cognitive-services/speech-service/media/sdk/qs-csharp-dotnet-windows-03-nuget-install-1.0.0.png)
6666

6767
1. Accept all agreements and licenses to start the installation.
6868

6969
After the package is installed, a confirmation appears in the **Package Manager Console** window.
7070

7171
### Choose target architecture
7272

73-
To build and run the console application, create a platform configuration matching your computer's architecture.
73+
To build and run the console application, create a platform configuration that matches your computer's architecture.
7474

75-
1. From the menu bar, select **Build** > **Configuration Manager**. The **Configuration Manager** dialog box appears.
75+
1. From the menu bar, select **Build** > **Configuration Manager**. The **Configuration Manager** dialog appears.
7676

77-
![Configuration Manager dialog box](~/articles/cognitive-services/speech-service/media/sdk/vs-configuration-manager-dialog-box.png)
77+
1. In the **Active solution platform** drop-down box, select **New**. The **New Solution Platform** dialog appears.
7878

79-
1. In the **Active solution platform** drop-down box, select **New**. The **New Solution Platform** dialog box appears.
79+
![Screenshot that shows the Configuration Manager dialog.](~/articles/cognitive-services/speech-service/media/sdk/vs-configuration-manager-dialog-box.png)
8080

8181
1. In the **Type or select the new platform** drop-down box:
8282
- If you're running 64-bit Windows, select **x64**.

articles/cognitive-services/Speech-Service/includes/quickstarts/platform/csharp-dotnetcore-windows.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,9 +24,9 @@ This guide shows how to install the [Speech SDK](~/articles/cognitive-services/s
2424

2525
This quickstart requires:
2626

27-
* On Windows, you need the [Microsoft Visual C++ Redistributable for Visual Studio 2019](https://support.microsoft.com/topic/the-latest-supported-visual-c-downloads-2647da03-1eea-4433-9aff-95f26a218cc0) for your platform. Installing this for the first time may require a restart.
28-
* [.NET Core SDK](https://dotnet.microsoft.com/download)
29-
* [Visual Studio 2017](https://visualstudio.microsoft.com/downloads/) or later
27+
* [Microsoft Visual C++ Redistributable for Visual Studio 2019](https://support.microsoft.com/topic/the-latest-supported-visual-c-downloads-2647da03-1eea-4433-9aff-95f26a218cc0) for the Windows platform. Installing it for the first time might require a restart.
28+
* [.NET Core SDK](https://dotnet.microsoft.com/download).
29+
* [Visual Studio 2017](https://visualstudio.microsoft.com/downloads/) or later.
3030

3131
## Create a Visual Studio project and install the Speech SDK
3232

articles/cognitive-services/Speech-Service/includes/quickstarts/platform/csharp-unity.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
---
22
title: "Quickstart: Speech SDK for C# Unity platform setup - Speech service"
33
titleSuffix: Azure Cognitive Services
4-
description: 'Use this guide to set up your platform for C# Unity with the Speech service SDK.'
4+
description: 'Use this guide to set up your platform for C# Unity with the Speech SDK.'
55
services: cognitive-services
66
author: markamos
77
manager: nitinme
@@ -16,31 +16,31 @@ ms.custom: devx-track-csharp, ignite-fall-2021
1616
This guide shows how to install the [Speech SDK](~/articles/cognitive-services/speech-service/speech-sdk.md) for [Unity](https://unity3d.com/).
1717

1818
> [!NOTE]
19-
> The Speech SDK for Unity supports Windows Desktop (x86 and x64) or Universal Windows Platform (x86, x64, ARM/ARM64), Android (x86, ARM32/64), iOS (x64 simulator and ARM64) and Mac (x64).
19+
> The Speech SDK for Unity supports Windows Desktop (x86 and x64) or Universal Windows Platform (x86, x64, ARM/ARM64), Android (x86, ARM32/64), iOS (x64 simulator and ARM64), and Mac (x64).
2020
2121
[!INCLUDE [License Notice](~/includes/cognitive-services-speech-service-license-notice.md)]
2222

2323
## Prerequisites
2424

2525
This quickstart requires:
2626

27-
- On Windows, you need the [Microsoft Visual C++ Redistributable for Visual Studio 2019](https://support.microsoft.com/topic/the-latest-supported-visual-c-downloads-2647da03-1eea-4433-9aff-95f26a218cc0) for your platform. Installing this for the first time may require a restart.
27+
- [Microsoft Visual C++ Redistributable for Visual Studio 2019](https://support.microsoft.com/topic/the-latest-supported-visual-c-downloads-2647da03-1eea-4433-9aff-95f26a218cc0) for the Windows platform. Installing it for the first time might require a restart.
2828
- [Unity 2018.3 or later](https://store.unity.com/) with [Unity 2019.1 adding support for UWP ARM64](https://blogs.unity3d.com/2019/04/16/introducing-unity-2019-1/#universal).
29-
- [Visual Studio 2019](https://visualstudio.microsoft.com/downloads/). Version 15.9 or higher of Visual Studio 2017 is also acceptable.
30-
- For Windows ARM64 support, install the [optional build tools for ARM64, and the Windows 10 SDK for ARM64](https://blogs.windows.com/buildingapps/2018/11/15/official-support-for-windows-10-on-arm-development/).
31-
- On Android, you need an ARM-based Android device (API 23: Android 6.0 Marshmallow or higher) enabled for development with a working microphone.
32-
- On iOS, you need an iOS device (ARM64) enabled for development with a working microphone.
33-
- On macOS, you need Mac device (x64) and the latest LTS version of Unity 2019 (or higher) for integrated support for microphone access in Unity Player settings.
29+
- [Visual Studio 2019](https://visualstudio.microsoft.com/downloads/). Version 15.9 or later of Visual Studio 2017 is also acceptable.
30+
- For Windows ARM64 support, installation of the [optional build tools for ARM64 and the Windows 10 SDK for ARM64](https://blogs.windows.com/buildingapps/2018/11/15/official-support-for-windows-10-on-arm-development/).
31+
- On Android, an ARM-based Android device (API 23: Android 6.0 Marshmallow or later) enabled for development with a working microphone.
32+
- On iOS, an iOS device (ARM64) enabled for development with a working microphone.
33+
- On macOS, a Mac device (x64) and the latest LTS version of Unity 2019 (or later) for integrated support for microphone access in Unity Player settings.
3434

3535
## Install the Speech SDK
3636

3737
To install the Speech SDK for Unity, follow these steps:
3838

39-
1. Download and open the [Speech SDK for Unity](https://aka.ms/csspeech/unitypackage), which is packaged as a Unity asset package (.unitypackage), and should already be associated with Unity. When the asset package is opened, the **Import Unity Package** dialog box appears. You may need to create and open an empty project for this step to work.
39+
1. Download and open the [Speech SDK for Unity](https://aka.ms/csspeech/unitypackage). It's packaged as a Unity asset package (.unitypackage) and should already be associated with Unity. When the asset package is opened, the **Import Unity Package** dialog appears. You might need to create and open an empty project for this step to work.
4040

41-
[![Import Unity Package dialog box in the Unity Editor](~/articles/cognitive-services/speech-service/media/sdk/qs-csharp-unity-01-import.png)](~/articles/cognitive-services/speech-service/media/sdk/qs-csharp-unity-01-import.png#lightbox)
41+
1. Ensure that all files are selected, and then select **Import**. After a few moments, the Unity asset package is imported into your project.
4242

43-
1. Ensure that all files are selected, and select **Import**. After a few moments, the Unity asset package is imported into your project.
43+
[![Screenshot of the Import Unity Package dialog in the Unity Editor.](~/articles/cognitive-services/speech-service/media/sdk/qs-csharp-unity-01-import.png)](~/articles/cognitive-services/speech-service/media/sdk/qs-csharp-unity-01-import.png#lightbox)
4444

4545
For more information about importing asset packages into Unity, see the [Unity documentation](https://docs.unity3d.com/Manual/AssetPackages.html).
4646

0 commit comments

Comments
 (0)