Merge feature/nuget into develop (#191)

Merge `feature/nuget` into `develop`

Author: ermshiperete

CHANGELOG.md

@@ -0,0 +1,35 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+<!-- Available types of changes:
+### Added
+### Changed
+### Fixed
+### Deprecated
+### Removed
+### Security
+-->
+
+## [Unreleased]
+
+### Changed
+
+- Create nuget packages
+- [SIL.LCModel.Build.Tasks] `IdlImp` task now reports errors and warnings through msbuild logger
+  instead of console
+- [SIL.LCModel.Build.Tasks] `LcmGenerate` task now allows to specify location that contains
+  `HandGenerated.xml` and `IntPropTypeOverrides.xml` files (`HandGeneratedDir` property)
+
+### Deprecated
+
+- [SIL.LCModel.Utils] `MiscUtils.RunProcess` is deprecated in favor of
+  `ProcessExtensions.RunProcess`
+- [SIL.LCModel.Utils] `MiscUtils.IsWindows`, `MiscUtils.IsUnix`, `MiscUtils.IsMac`,
+  `MiscUtils.IsMono`, and `MiscUtils.IsDotNet` are deprecated in favor of the corresponding
+  `Process.Is*` properties
+
+[Unreleased]: https://github.com/sillsdev/liblcm/compare/v9.0.0...develop

CommonAssemblyInfo.cs

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
+  <Target Name="CopyPackage" AfterTargets="Pack" Condition="'$(LOCAL_NUGET_REPO)'!='' AND '$(IsPackable)'=='true'">
+    <Copy SourceFiles="$(PackageOutputPath)/$(PackageId).$(PackageVersion).nupkg"
+      DestinationFolder="$(LOCAL_NUGET_REPO)"/>
+  </Target>
+</Project>

Directory.Build.targets

@@ -0,0 +1,27 @@
+mode: ContinuousDeployment
+increment: Patch
+assembly-versioning-scheme: MajorMinor
+branches:
+  master:
+    tag: beta
+    regex: (origin/)?(master)
+    is-mainline: true
+  develop:
+    tag: unstable
+    regex: (origin/)?develop
+    is-mainline: true
+  hotfix:
+    tag: beta
+    regex: (origin/)?hotfix[/-]
+    increment: Patch
+    prevent-increment-of-merged-branch-version: false
+    track-merge-target: false
+    tracks-release-branches: false
+    is-release-branch: false
+  pull-request:
+    mode: ContinuousDeployment
+    tag: PR
+  feature:
+    regex: feature[/-]
+    mode: ContinuousDeployment
+    tag: alpha

GitVersion.yml

@@ -1,55 +1,65 @@
-LCModel Library
-===============
+# LCModel Library
 
-Description
------------
+## Description
 
 The library for the SIL Language and Culture Model.
-The liblcm library is the core [FieldWorks](github.com/sillsdev/FieldWorks) model for linguistic analyses of languages. Tools in this library provide the ability to store and interact with language and culture data, including anthropological, text corpus, and linguistics data.
 
-Instructions
-------------
+The liblcm library is the core [FieldWorks](https://github.com/sillsdev/FieldWorks) model for
+linguistic analyses of languages. Tools in this library provide the ability to store and interact
+with language and culture data, including anthropological, text corpus, and linguistics data.
+
+## Instructions
 
 1. Install Required Software
-- git
-- Visual Studio 2017 or MonoDevelop
+
+	- git
+	- Visual Studio 2019 (with C++), MonoDevelop, or JetBrains Rider
 
 2. Clone the liblcm repository
-- Open a terminal (or git bash on Windows) and cd into a desired directory.
-- Run `git clone https://github.com/sillsdev/liblcm.git`
+
+	- Open a terminal (or git bash on Windows) and cd into a desired directory.
+	- Run `git clone https://github.com/sillsdev/liblcm.git`
 
 3. Build liblcm
-- cd into the directory of the cloned liblcm repository.
 
-**On Windows**, `LCM.sln` can be built from within Visual Studio, or
-- Open Visual Studio Developer Command Prompt.
-- Run `build.cmd` to build the liblcm library.
+	- cd into the directory of the cloned liblcm repository.
 
-**On Linux**
-- Run `build.sh` to build the liblcm library.
+	On Windows:
 
-By default, this will build liblcm in the Debug configuration.
-To build with a different configuration, use:
+	- Run the appropriate `vsvars*.bat`. Alternatively, `LCM.sln` can be built from within Visual Studio.
+	- Run `build.cmd` to build the liblcm library.
+
+	On Linux:
 
-    build.(cmd|sh) (Debug|Release)
+	- Run `build.sh` to build the liblcm library.
 
-Debugging
----------
+By default, this will build liblcm in the Debug configuration.
+To build with a different configuration, use:
 
-The LCModel library depends on multiple libpalaso files that are downloaded automatically by triggering the build script. The option to build liblcm using locally built dependencies is also available to assist with debugging. Copy all of the relevent files from the libpalaso output folder into the lib/downloads folder in liblcm, then build with the command:
+```bash
+build.(cmd|sh) (Debug|Release)
+```
 
-    build.(cmd|sh) Debug Build True
+## Debugging
 
-Build a 64-bit build with the command:
+The LCModel library consumes multiple libpalaso files as NuGet packages. FieldWorks and other
+projects consume LCModel as a NuGet package. Several options to debug across NuGet dependencies are
+discussed on [this wiki](https://github.com/sillsdev/libpalaso/wiki/Developing-with-locally-modified-nuget-packages).
+To publish and consume LCModel through local sources:
 
-    build.(cmd|sh) Debug Build False x64
+- Set an environment variable `LOCAL_NUGET_REPO` with the path to a folder on your computer (or
+  local network) to publish locally-built packages
+- See [these instructions](https://docs.microsoft.com/en-us/nuget/hosting-packages/local-feeds)
+  to enable local package sources
+- `build /t:pack` will pack nuget packages and publish them to `LOCAL_NUGET_REPO`
 
-Tests
------
+## Tests
 
-**On Linux**
+### Linux
 
-    (. environ && cd artifacts/Debug/ && ICU_DATA="IcuData/" nunit-console SIL.LCModel*Tests.dll )
+```bash
+(. environ && cd artifacts/Debug/net461/ && ICU_DATA="IcuData/icudt54l" nunit-console SIL.LCModel*Tests.dll )
+```
 
 **On Windows with ReSharper**
 
@@ -66,4 +76,4 @@ Tests
 	4. Execute: "..\..\packages\NUnit.ConsoleRunner.3.9.0\tools\nunit3-console.exe" SIL.LCModel.Tests.dll
 	   (Or specify one of the other SIL.LCModel*Tests.dll)
 	5. To debug the tests from Visual Studio; Immediately after the tests have started
-	   running "Attach to Process..." and select 'nunit-agent.exe'.
+	   running "Attach to Process..." and select 'nunit-agent.exe'.