Skip to content

Commit a15297b

Browse files
authored
docs(README): added note about .NET 5
1 parent e26827c commit a15297b

File tree

1 file changed

+10
-5
lines changed

1 file changed

+10
-5
lines changed

README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,16 @@
11
# AdventOfCodeBase
2-
Template project for solving Advent of Code in C#, running on .NET Core 3.1.
2+
Template project for solving Advent of Code in C#, running on [.NET Core 3.1](https://dotnet.microsoft.com/download/dotnet-core/3.1). If you wish to use .NET 5, [you can](#changing-from-net-core-to-net-5).
33

44
- [Features](#features)
55
- [Getting started](#getting-started)
66
- [Usage](#usage)
7-
- [Requirements](#requirements)
87
- [Configuration](#configuration)
98
- [Running the project](#running-the-project)
109
- [Example projects](#example-projects)
1110
- [Notes](#notes)
1211
- [Generating Previous Year's Solution Files](#generating-previous-years-solution-files)
1312
- [Using a Solution's Constructor](#using-a-solutions-constructor)
13+
- [Changing From .NET Core To .NET 5](#changing-from-net-core-to-net-5)
1414
- [Contributing](#contributing)
1515
- [License](#license)
1616

@@ -29,9 +29,6 @@ Feel free to make any modifications you want. However, you probably do not want
2929
If any solution files that you need are not already included, see **[Generating Previous Year's Solution Files](#generating-previous-years-solution-files)**.
3030

3131
## Usage
32-
### Requirements
33-
* [.NET Core 3.1](https://dotnet.microsoft.com/download/dotnet-core/3.1)
34-
3532
### Configuration
3633
Create `config.json` with the following key/value pairs. If you run the program without adding a `config.json` file, one will be created for you without a cookie field. The program will not be able to fetch puzzle inputs from the web before a valid cookie is added to the configuration.
3734
```json
@@ -103,6 +100,14 @@ protected override string SolvePartTwo()
103100
* If stuck you can set the `DebugInput` variable at the top of the constructor, and it will overwrite `Input` variable, so you won't need to change all your references.
104101
* The extension method `SplitByNewLine()` will do exactly that, example: `string[] lines = Input.SplitByNewLine()` will split your input into lines for enumeration.
105102

103+
### Changing from .NET Core to .NET 5
104+
Simply swap out the target framework in `AdventOfCode.csproj`.
105+
```diff
106+
- <TargetFramework>netcoreapp3.1</TargetFramework>
107+
+ <TargetFramework>net5.0</TargetFramework>
108+
```
109+
110+
106111
## Contributing
107112
Sure! Fork the project, make your changes, and create a pull request. Submitted issues and pull requests are quite welcome.
108113

0 commit comments

Comments
 (0)