dev
Rev | Line | |
---|
[e6a6d9a] | 1 | # Introduction
|
---|
| 2 | TODO: Give a short introduction of your project. Let this section explain the objectives or the motivation behind this project.
|
---|
| 3 |
|
---|
| 4 | # Getting Started
|
---|
| 5 | TODO: Guide users through getting your code up and running on their own system. In this section you can talk about:
|
---|
| 6 | 1. Installation process
|
---|
| 7 | 2. Software dependencies
|
---|
| 8 | 3. Latest releases
|
---|
| 9 | 4. API references
|
---|
| 10 |
|
---|
| 11 | # Build and Test
|
---|
| 12 | TODO: Describe and show how to build your code and run the tests.
|
---|
| 13 |
|
---|
| 14 | # Contribute
|
---|
| 15 | TODO: Explain how other users and developers can contribute to make your code better.
|
---|
| 16 |
|
---|
| 17 | 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:
|
---|
| 18 | - [ASP.NET Core](https://github.com/aspnet/Home)
|
---|
| 19 | - [Visual Studio Code](https://github.com/Microsoft/vscode)
|
---|
| 20 | - [Chakra Core](https://github.com/Microsoft/ChakraCore) |
---|
Note:
See
TracBrowser
for help on using the repository browser.