/Vigicrues.Client

.NET client for the Vigicrues API

Primary LanguageC#MIT LicenseMIT

Vigicrues.Client

Nuget MyGet Release

Build status Build Code coverage

This library provides a .NET wrapper around the Vigicrues API, which reports information about flooding hazards in France.

Usage

Releases for this library can be found on NuGet. Developement releases can be found on MyGet (and will most certainly break your project...).

Development

Prerequisites

This library requires:

Build

The build system for this project is mainly organized around MSBuild script files that can be called from any CI provider as well as on your computer (use build.bat or build.sh depending on your platform):

  • build.bat clean: cleans the project.
  • build.bat compile: builds the project.
  • build.bat test: executes the automated tests.
    • code coverage is gathered and results can be viewed in the tmp\tst folder.
  • build.bat analyze: analyzes the project.
  • build.bat package: packages the project.
    • the library is packaged in a NuGet package file in the tmp\out\bin folder.
  • build.bat build: compile + test + analyze.
  • build.bat rebuild: clean + build (the default).
  • build.bat relaese: rebuild + package.