diff options
| author | user <user@xiangyangli.com> | 2017-12-01 16:22:19 +0000 |
|---|---|---|
| committer | user <user@xiangyangli.com> | 2017-12-01 16:22:19 +0000 |
| commit | d28ed52854838b129feb1c17738ccb528eafa6e4 (patch) | |
| tree | 1b9f5490f9924813736344b793734f6ba9f862f1 /README.md | |
| download | dotfiles-d28ed52854838b129feb1c17738ccb528eafa6e4.tar.xz dotfiles-d28ed52854838b129feb1c17738ccb528eafa6e4.zip | |
Added README.md file
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md new file mode 100644 index 0000000..a4579b6 --- /dev/null +++ b/README.md @@ -0,0 +1,20 @@ +# Introduction +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: +1. Installation process +2. Software dependencies +3. Latest releases +4. API references + +# 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. + +If you want to learn more about creating good readme files then refer the following [guidelines](https://www.visualstudio.com/en-us/docs/git/create-a-readme). You can also seek inspiration from the below readme files: +- [ASP.NET Core](https://github.com/aspnet/Home) +- [Visual Studio Code](https://github.com/Microsoft/vscode) +- [Chakra Core](https://github.com/Microsoft/ChakraCore)
\ No newline at end of file |