Skip to content

PREREQUISITES.md

Latest commit

 

History

History
113 lines (74 loc) · 2.3 KB

PREREQUISITES.md

File metadata and controls

113 lines (74 loc) · 2.3 KB
Raw

Prerequisites

Quick setup guide to start developing WATS converters.

Required Software

1. .NET SDK 8.0

Download: https://dotnet.microsoft.com/download/dotnet/8.0

Install "SDK x64" installer → Accept defaults.

Verify:

dotnet --version

2. .NET Framework 4.8 Developer Pack

Download: https://dotnet.microsoft.com/download/dotnet-framework/net48

Install "Developer Pack" → Accept defaults.

Windows includes the runtime, but you need the Developer Pack to build converters.

3. Visual Studio Code

Download: https://code.visualstudio.com/

Install and check these options:

  • ✅ Add to PATH
  • ✅ Add "Open with Code" to Explorer

Verify:

code --version

Install C# Extension:

  1. Open VS Code
  2. Press Ctrl+Shift+X
  3. Search "C# Dev Kit" (Microsoft)
  4. Install

4. WATS Client

Download: https://download.wats.com

Install WATS Client → Configure server connection.

Why needed: Required to submit test reports to WATS server. Without it, you can only validate conversions locally.

Getting Started

1. Get the DevKit

Best Practice: Use as a template on GitHub

  1. Visit https://github.com/Virinco/WATS-DevKit
  2. Click "Use this template" → Create a new repository
  3. Clone your new repo: 
    git clone https://github.com/YOUR-ORG/YOUR-PROJECT.git
cd YOUR-PROJECT

Alternative: Clone and remove git history:

git clone --depth 1 https://github.com/Virinco/WATS-DevKit.git MyConverters
cd MyConverters
Remove-Item -Recurse -Force .git
git init  # Optional: start fresh

2. Open in VS Code

Right-click folder → Open with Code

Or from PowerShell (if already cloned):

cd path\to\WATS-DevKit
code .

3. Verify Installation

Build example converters:

dotnet build

# Run tests
dotnet test Converters/ExampleConverters/tests/

If all succeed: ✅ Ready to develop!

Next Steps

  1. Read QUICKSTART.md
  2. Run Tools/NewConverter.ps1 to create your first converter
  3. Check Converters/ExampleConverters/ for examples

Support

Email: support@wats.com

Note: Custom converter development support is not included in general support agreements and is normally charged by the hour.