sherpa-ncnn/scripts/dotnet/notes.md

Introduction

This directory is for .Net.

We use https://github.com/Mizux/dotnet-native as a reference to build native Nuget packages for various platforms such as Linux, macOS, and Windows.

Install .Net on Linux

Please see https://learn.microsoft.com/en-us/dotnet/core/install/linux-scripted-manual for details.

The following is just some notes about the installation:

wget https://dot.net/v1/dotnet-install.sh -O dotnet-install.sh
chmod +x dotnet-install.sh
./dotnet-install.sh --help
./dotnet-install.sh  --install-dir /star-fj/fangjun/software/dotnet
export PATH=/star-fj/fangjun/software/dotnet:$PATH

# Check that the installation is successful
which dotnet
dotnet --info

# To install the runtime, use
./dotnet-install.sh --runtime dotnet --install-dir /star-fj/fangjun/software/dotnet/

Test sherpa-ncnn nuget packages

cd /tmp
mkdir hello
cd hello
dotnet new sln

dotnet new console -o test-sherpa-ncnn


dotnet sln add ./test-sherpa-ncnn/test-sherpa-ncnn.csproj
cd test-sherpa-ncnn

# please always use the latest version.
dotnet add package org.k2fsa.sherpa.ncnn -v 1.9.0

Notes about dotnet

To list available nuget sources:

dotnet nuget list source

To publish a package:

export MY_API_KEY=xxxxxx
dotnet nuget push ./org.k2fsa.sherpa.ncnn.runtime.osx-x64.1.8.2.nupkg --api-key $MY_API_KEY --source https://api.nuget.org/v3/index.json
dotnet nuget push ./org.k2fsa.sherpa.ncnn.1.8.2.nupkg --api-key $MY_API_KEY --source https://api.nuget.org/v3/index.json

To clear all caches:

dotnet nuget locals all --clear