Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added readme.txt for the NuGet packages #644

Merged
merged 1 commit into from
Feb 27, 2021
Merged

Added readme.txt for the NuGet packages #644

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion src/NLog.Web.AspNetCore/NLog.Web.AspNetCore.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,8 @@ See also https://github.com/NLog/NLog.Web/releases
<TreatWarningsAsErrors>true</TreatWarningsAsErrors>
<GenerateDocumentationFile>true</GenerateDocumentationFile>
<AssemblyTitle>$(Title)</AssemblyTitle>
<EmbedUntrackedSources>true</EmbedUntrackedSources> <!-- EmbedUntrackedSources for deterministic build -->
<EmbedUntrackedSources>true</EmbedUntrackedSources>
<!-- EmbedUntrackedSources for deterministic build -->
</PropertyGroup>
<ItemGroup>
<None Include="N.png" Pack="true" PackagePath=""/>
Expand Down Expand Up @@ -101,4 +102,10 @@ See also https://github.com/NLog/NLog.Web/releases
<ItemGroup>
<Compile Include="..\Shared\**\*.cs" />
</ItemGroup>
<ItemGroup>
<Content Include="readme.txt">
<Pack>true</Pack>
<PackagePath>\</PackagePath>
</Content>
</ItemGroup>
</Project>
18 changes: 18 additions & 0 deletions src/NLog.Web.AspNetCore/readme.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
Welcome to NLog for ASP.NET Core!

To get started, check one of these short tutorials:

- Getting started for ASP.NET Core 5: https://github.com/NLog/NLog/wiki/Getting-started-with-ASP.NET-Core-5
- Getting started for ASP.NET Core 3: https://github.com/NLog/NLog/wiki/Getting-started-with-ASP.NET-Core-3
- Getting started for ASP.NET Core 2: https://github.com/NLog/NLog/wiki/Getting-started-with-ASP.NET-Core-2

# More information

- How to use structured logging: https://github.com/NLog/NLog/wiki/How-to-use-structured-logging
- All config options: https://nlog-project.org/config

# Troubleshooting

Having issues to get things working? It's recommend to follow to Troubleshooting https://github.com/NLog/NLog/wiki/Logging-troubleshooting page.

For questions, StackOverflow (https://stackoverflow.com/questions/tagged/nlog) is recommend
6 changes: 6 additions & 0 deletions src/NLog.Web/NLog.Web.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,4 +57,10 @@ For ASP.NET Core: Check https://www.nuget.org/packages/NLog.Web.AspNetCore
<Compile Include="..\Shared\**\*.cs" />
<None Include="NLog.snk" />
</ItemGroup>
<ItemGroup>
<Content Include="readme.txt">
<Pack>true</Pack>
<PackagePath>\</PackagePath>
</Content>
</ItemGroup>
</Project>
16 changes: 16 additions & 0 deletions src/NLog.Web/readme.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
Welcome to NLog for ASP.NET!

For ASP.NET Core, you need the NLog.Web.AspNetCore package and not this one (https://www.nuget.org/packages/NLog.Web.AspNetCore)

To get started, check this tutorials: https://github.com/NLog/NLog/wiki/Tutorial

# More information

- How to use structured logging: https://github.com/NLog/NLog/wiki/How-to-use-structured-logging
- All config options: https://nlog-project.org/config

# Troubleshooting

Having issues to get things working? It's recommend to follow to Troubleshooting https://github.com/NLog/NLog/wiki/Logging-troubleshooting page.

For questions, StackOverflow (https://stackoverflow.com/questions/tagged/nlog) is recommend