TODO: Give a short introduction of your project. Let this section explain the objectives or the motivation behind this project.
TODO: Guide users through getting your code up and running on their own system. In this section you can talk about:
- Installation process
- Software dependencies
- Latest releases
- API references
TODO: Describe and show how to build your code and run the tests.
- Codemaid - Not a NuGet package, but extension.
- Look in the Error List in visual studio, to check if there are any issues to resolve.
- Serilog:
- Note that Serilog analyser wants Pascal naming (not Camel) in the variables used in the MessageText part:
- eg.: Log.Information(" The key '{Key}' was found in cache. Value is: '{Guid}'.", key, guid);
TODO: Explain how other users and developers can contribute to make your code better.
If you want to learn more about creating good readme files then refer the following guidelines. You can also seek inspiration from the below readme files: