Skip to content

Instantly share code, notes, and snippets.

@mapfel
Created October 20, 2020 22:42
Show Gist options
  • Save mapfel/774ae14065ac7758d37a62fee935f17f to your computer and use it in GitHub Desktop.
Save mapfel/774ae14065ac7758d37a62fee935f17f to your computer and use it in GitHub Desktop.
Default Repository Readme from Azure

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. You can also seek inspiration from the below readme files:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment