1 changed file
README.md + | ||
Add comment 1 Plus # Introduction
Add comment 2 Plus TODO: Give a short introduction of your project. Let this section explain the objectives or the motivation behind this project.
Add comment 3 Plus
Add comment 4 Plus # Getting Started
Add comment 5 Plus TODO: Guide users through getting your code up and running on their own system. In this section you can talk about:
Add comment 6 Plus 1. Installation process
Add comment 7 Plus 2. Software dependencies
Add comment 8 Plus 3. Latest releases
Add comment 9 Plus 4. API references
Add comment 10 Plus
Add comment 11 Plus # Build and Test
Add comment 12 Plus TODO: Describe and show how to build your code and run the tests.
Add comment 13 Plus
Add comment 14 Plus # Contribute
Add comment 15 Plus TODO: Explain how other users and developers can contribute to make your code better.
Add comment 16 Plus
Add comment 17 Plus If you want to learn more about creating good readme files then refer the following [guidelines](https://docs.microsoft.com/en-us/azure/devops/repos/git/create-a-readme?view=azure-devops). You can also seek inspiration from the below readme files:
Add comment 18 Plus - [ASP.NET Core](https://github.com/aspnet/Home)
Add comment 19 Plus - [Visual Studio Code](https://github.com/Microsoft/vscode)
Add comment 20 Plus - [Chakra Core](https://github.com/Microsoft/ChakraCore)