Updated README
This commit is contained in:
parent
c7018b7037
commit
81babd5262
1 changed files with 23 additions and 22 deletions
45
README.md
45
README.md
|
|
@ -1,23 +1,24 @@
|
||||||
# Introduction
|
# JJ's Test Wiki
|
||||||
TODO: Give a short introduction of your project. Let this section explain the objectives or the motivation behind this project.
|
|
||||||
|
TODO: Give a short introduction of your project. Let this section explain the objectives or the motivation behind this project.
|
||||||
# Getting Started
|
|
||||||
TODO: Guide users through getting your code up and running on their own system. In this section you can talk about:
|
# Getting Started
|
||||||
1. Installation process
|
TODO: Guide users through getting your code up and running on their own system. In this section you can talk about:
|
||||||
2. Software dependencies
|
1. Installation process
|
||||||
3. Latest releases
|
2. Software dependencies
|
||||||
4. API references
|
3. Latest releases
|
||||||
|
4. API references
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
# Build and Test
|
|
||||||
TODO: Describe and show how to build your code and run the tests.
|
# Build and Test
|
||||||
|
TODO: Describe and show how to build your code and run the tests.
|
||||||
# Contribute
|
|
||||||
TODO: Explain how other users and developers can contribute to make your code better.
|
# Contribute
|
||||||
|
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](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:
|
|
||||||
- [ASP.NET Core](https://github.com/aspnet/Home)
|
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:
|
||||||
- [Visual Studio Code](https://github.com/Microsoft/vscode)
|
- [ASP.NET Core](https://github.com/aspnet/Home)
|
||||||
|
- [Visual Studio Code](https://github.com/Microsoft/vscode)
|
||||||
- [Chakra Core](https://github.com/Microsoft/ChakraCore)
|
- [Chakra Core](https://github.com/Microsoft/ChakraCore)
|
||||||
Loading…
Add table
Add a link
Reference in a new issue