Skip to content
This repository has been archived by the owner on Jun 5, 2019. It is now read-only.

Latest commit

 

History

History
49 lines (34 loc) · 3.38 KB

CONTRIBUTING.md

File metadata and controls

49 lines (34 loc) · 3.38 KB
Raw

Developer instructions

Prerequisites

  • Install .NET Core SDK version 2.1.400 or later
  • Have the NuGet packages M.nupkg and MGen.nupkg on local feed. This can be done by placing them in %STAR_NUGET% folder or by setting the environment variable to the folder where they are located, example: set STAR_NUGET="C:\FolderContainingNuGetPackages"
    • M.nupkg may be built from the DoctorM git repository while MGen.nupkg may be built from MGen.
  • Visual Studio 2017 --version 15.8.2 or higher.
    • Make sure .NET Framework 4.7.2 is installed in VS 2017. If not, run the VS Installer, select "Modify" and then in "Individual Components", select that version and continue on.
  • DebugView which is used to debug the mapper.

Build scripts specific prerequisites

  • Install the latest global .NET Core Cake tool by running dotnet tool install -g Cake.Tool.
  • Add nuget.exe to PATH.
  • Make sure that the MSBuild version that is used comes from your Visual Studio installation and not from a previous installation of .NET Framework. The easiest way to test this is to run msbuild /version which should return a 15.X version. If it returns something like 4.X, then you have to either
    • add C:\Program Files (x86)\Microsoft Visual Studio\2017\Professional\MSBuild\15.0\Bin to PATH (check both System AND User). Make sure it's inserted before any C:\Windows\Microsoft.NET\Framework\v4.0.30319
    • or run C:\Program Files (x86)\Microsoft Visual Studio\2017\Professional\Common7\Tools\VsDevCmd.bat which will only set proper environment variable values for the current process.

How to build and run

Build and run using CLI

  1. Clone this repo to your local machine
  2. Build the solution by executing build.bat in Windows or ./build.bat in Git Bash
  3. Run it by executing run.bat in Windows or ./run.bat in Git Bash

There is also a package.bat script which creates a StarPack of the application.

Build and run using Visual Studio

  1. Clone this repo to your local machine
  2. Open the .sln file in Visual Studio
  3. Build and run it using Debug in Visual Studio (Debug > Start debugging or F5). Note that you have to start M.exe yourself by doing this.

Using Debug View

We are currently using Microsoft's DebugView to chase down errors with the mappers.

  • After downloading DebugView, run as an administrator.
  • The first window to pop up should be the DebugView Filter. If not, you can find it under Edit->Filter/Highlight
  • add sc_ to Include filters
  • make sure it's running in the background. If the app crashes due to mapping, something should pop up. the message/messages you get combined with a brief description of the steps you took prior to the crash will hopefully help identify what caused the crash.

Contributing code

To contribute code to this repository, follow the instructions in the guidelines.

How to release a package

To release the app to the warehouse, follow the instructions in the guidelines.