Skip to content

Commit

Permalink
add Nuget Package Readme and file (#2575)
Browse files Browse the repository at this point in the history
* add Nuget Package Readme and file
  • Loading branch information
romanett authored Apr 5, 2024
1 parent ca848af commit d4f1d40
Show file tree
Hide file tree
Showing 2 changed files with 41 additions and 0 deletions.
36 changes: 36 additions & 0 deletions Docs/NugetREADME.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
# OPC UA .NET Standard stack documentation

## Overview

The OPC UA .NET Standard stack enables you to build multi-platform OPC UA Applications with rich functionality including:
- Server
- Client
- PubSub


### For more information and license terms, see the projects official [Website](http://opcfoundation.github.io/UA-.NETStandard).

## Getting started

The reference [Client](https://github.com/OPCFoundation/UA-.NETStandard/tree/master/Applications/ConsoleReferenceClient) & [Server](https://github.com/OPCFoundation/UA-.NETStandard/tree/master/Applications/ReferenceServer) projects provide a starting point in implementing your own application.

<!---
Simple Client:
```C#
ToDo
```
Simple Server:
```C#
ToDo
```
-->


## Packages Overview

Caution, there are multiple packages available with different functional scopes, for a detailed overview take a look at the [Information about the different Packages](https://github.com/OPCFoundation/UA-.NETStandard/blob/master/Docs/PlatformBuild.md#further-information-on-the-supported-nuget-packages).

## Additional documentation

Additional information about the OPC UA .NET Standard stack is available on the GitHub Repo of the project in the [detailed Documentation](https://github.com/OPCFoundation/UA-.NETStandard/tree/master/Docs#opc-ua-net-standard-stack-documentation).
5 changes: 5 additions & 0 deletions common.props
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@
<!-- deprecated <PackageLicenseUrl>https://opcfoundation.org/license/source/1.11/index.html</PackageLicenseUrl>-->
<PackageLicenseFile>licenses/LICENSE.txt</PackageLicenseFile>
<PackageReleaseNotes>$(RepositoryUrl)/releases</PackageReleaseNotes>
<PackageReadmeFile>NugetREADME.md</PackageReadmeFile>
<PackageTags>OPCFoundation OPC UA netstandard ios linux dotnet net netcore uwp</PackageTags>
</PropertyGroup>

Expand All @@ -52,6 +53,10 @@
<None Include="$(MSBuildThisFileDirectory)/nuget/logo.jpg" Pack="true" PackagePath="$(PackageIcon)"/>
</ItemGroup>

<ItemGroup Condition="'$(IsPackable)' != 'false'">
<None Include="$(MSBuildThisFileDirectory)/Docs/NugetREADME.md" Pack="true" PackagePath="$(PackageReadmeFile)"/>
</ItemGroup>

<ItemGroup Condition="'$(NBGV_PublicRelease)' != ''">
<PackageReference Include="Microsoft.SourceLink.GitHub" Version="8.0.0" PrivateAssets="All"/>
</ItemGroup>
Expand Down

0 comments on commit d4f1d40

Please sign in to comment.