Skip to content

Commit ce34ba1

Browse files
committed
Added requirements to readme
1 parent fdeb1c2 commit ce34ba1

1 file changed

Lines changed: 12 additions & 1 deletion

File tree

README.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ Support plans provide private email support, expert usage advice for our project
2424
These support plans help fund our OSS commitments to provide better software for everyone.
2525

2626
## 📖 Table of Contents
27+
- [Requirements](#requirements)
2728
- [Getting Started](#getting-started)
2829
- [Example Versions](#example-versions)
2930
- [CI Versioning Integrations](#integrations)
@@ -32,6 +33,16 @@ These support plans help fund our OSS commitments to provide better software for
3233
- [Version Strings](#version-strings)
3334
- [Additional Settings](#additional-settings)
3435

36+
## <a id="requirements" /> 📋 Requirements
37+
38+
- Your project must be using a modern SDK-style project file
39+
- One of the following .NET runtimes must be installed:
40+
- .NET 5
41+
- .NET 6
42+
43+
The runtime requirement is so that Build Versioning itself can run.
44+
Your project though can target whatever version of .NET you want (Framework/Standard/Core etc).
45+
3546
## <a id="getting-started" /> ⭐ Getting Started
3647

3748
1. [Install Build Versioning](https://www.nuget.org/packages/TurnerSoftware.BuildVersioning/)<br>
@@ -123,4 +134,4 @@ You can disable build versioning by setting `<SkipBuildVersioning>` in your proj
123134

124135
### Enable Output Logging
125136

126-
You can enable output logging for Build Versioning by specifying `<BuildVersioningLogLevel>` as `high`.
137+
You can enable output logging for Build Versioning by specifying `<BuildVersioningLogLevel>` as `normal` (for basic logging) or `high` (for detailed logging).

0 commit comments

Comments
 (0)