System Requirements and Building the Code

The code is separated into two branches. The master branch is for Visual Studio 2017 and later and is the default branch for all current and future development. The VSLegacy branch is for Visual Studio 2013 and 2015 and is being retained for legacy support only. In order to build the Visual Studio Spell Checker projects you will need the following tools:

  • For the master branch, you will need Visual Studio 2019 or later.

  • For the VSLegacy branch, you will need Visual Studio 2013 Update 5 or Visual Studio 2015 Update 3 and the related Visual Studio SDK.

Folder Layout

.\Source - This folder contains the source code for all of the projects.

.\NuGet - This contains the NuGet configuration file and script used to generate the definitions assembly NuGet package.

.\Docs - The Sandcastle Help File Builder project used to manage the spell checker project's documentation.

.\Deployment - This folder contains the deployment resources (the installer and all related files) generated by building the projects.

Building and Debugging the Projects

To build the projects, open the solution file (*.sln) found in the Source\ folder, set the proper configuration based on the version of Visual Studio being used and the configuration you want to build (Debug2019, Release2019, Debug2022, or Release2022).

In order to debug the projects:

  • Set the VSSpellCheckerDefinitions2017And2019 project (Visual Studio 2019) or the VSSpellCheckerDefinitions2022AndLater project (Visual Studio 2022) as the default project and then open its project properties.

  • Go to the Debug category.

  • For the Start Action option, set it to Start external program, click the "..." button after the text box, navigate to the installation folder for your version of Visual Studio and select the devenv.exe file in that folder (i.e. C:\Program Files (x86)\Microsoft Visual Studio\2019\Community\Common7\IDE\devenv.exe).

  • For the Command line arguments option, enter the value /rootsuffix Exp.

  • When you run the project, it should start a new instance of Visual Studio using the experimental instance settings.

See Also