From a84b601e4dc068003c5bcd08e7aa01de6913dbb4 Mon Sep 17 00:00:00 2001 From: Eberhard Beilharz Date: Wed, 5 Jan 2022 12:19:41 +0100 Subject: [PATCH] Update readme Also disable nuget uploading during Jenkins builds. --- Jenkinsfile | 2 +- README.md | 12 ++++++++---- source/icu.net.sln | 1 + 3 files changed, 10 insertions(+), 5 deletions(-) diff --git a/Jenkinsfile b/Jenkinsfile index ca8f45c9..d88b462d 100644 --- a/Jenkinsfile +++ b/Jenkinsfile @@ -11,6 +11,6 @@ xplatformBuildAndRunTests { linuxTool = 'mono-msbuild16' framework = 'netcore3.1' configuration = 'Release' - uploadNuGet = true + uploadNuGet = false nupkgPath = "output/*nupkg" } diff --git a/README.md b/README.md index e00004ea..2ecd74e4 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,28 @@ # Overview -icu-dotnet is the C# wrapper for a subset of [ICU4C](http://site.icu-project.org/home#TOC-What-is-ICU-) "ICU for C". +icu-dotnet is the C# wrapper for a subset of [ICU](https://icu.unicode.org/). >ICU is a mature, widely used set of C/C++ and Java libraries providing Unicode and Globalization support for software applications. ICU is widely portable and gives applications the same results on all platforms and between C/C++ and Java software. ## Status + + +[![Build status](https://ci.appveyor.com/api/projects/status/moxh4lc39hfeotq9?svg=true)](https://ci.appveyor.com/project/SIL_Language_Technology/icu-dotnet) ## Usage This library provides .NET classes and methods for (a subset of) the ICU C API. Please refer to the -[ICU API documentation](http://icu-project.org/apiref/icu4c/). In icu.net you'll find classes that -correspond to the C++ classes of ICU4C. +[ICU API documentation](https://unicode-org.github.io/icu-docs/apidoc/released/icu4c/). In icu.net +you'll find classes that correspond to the C++ classes of ICU4C. Although not strictly required it is recommended to call `Icu.Wrapper.Init()` at the start of the application. This will allow to use icu.net from multiple threads -(c.f. [ICU Initialization and Termination](http://userguide.icu-project.org/design#TOC-ICU-Initialization-and-Termination)). +(c.f. [ICU Initialization and Termination](https://unicode-org.github.io/icu/userguide/icu/design.html#icu4c-initialization-and-termination)). Similarly, it might be beneficial to call `Icu.Wrapper.Cleanup()` before exiting. Sample code: diff --git a/source/icu.net.sln b/source/icu.net.sln index 9e5ea39b..86e5b662 100644 --- a/source/icu.net.sln +++ b/source/icu.net.sln @@ -13,6 +13,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Solution items", "Solution .nuget\packages.config = .nuget\packages.config ..\.editorconfig = ..\.editorconfig ..\GitVersion.yml = ..\GitVersion.yml + ..\README.md = ..\README.md EndProjectSection EndProject Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "TestHelper", "TestHelper\TestHelper.csproj", "{F195ADCE-9129-446E-85E0-8EEAD01ED08D}"