aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorRoy Ben Shabat <Roy@twine-s.com>2017-10-30 15:19:14 +0000
committerRoy Ben Shabat <Roy@twine-s.com>2017-10-30 15:19:14 +0000
commit0df90907049d937e3757c266aa7b5b0a3d8af89c (patch)
tree30e859f64790801777fe188f22c772511dff2e91 /README.md
downloadTango-0df90907049d937e3757c266aa7b5b0a3d8af89c.tar.gz
Tango-0df90907049d937e3757c266aa7b5b0a3d8af89c.zip
Added README.md, .gitignore (VisualStudio) files
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/README.md b/README.md
new file mode 100644
index 000000000..a4579b63a
--- /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