From cc4273893ed6e7dd11476de82180e76bdf4bd5e6 Mon Sep 17 00:00:00 2001 From: Microsoft Open Source Date: Tue, 18 Feb 2020 06:51:34 -0800 Subject: [PATCH] Initial README.md commit --- README.md | 64 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..921018d --- /dev/null +++ b/README.md @@ -0,0 +1,64 @@ +--- +page_type: sample +languages: +- csharp +products: +- dotnet +description: "Add 150 character max description" +urlFragment: "update-this-to-unique-url-stub" +--- + +# Official Microsoft Sample + + + +Give a short description for your sample here. What does it do and why is it important? + +## Contents + +Outline the file contents of the repository. It helps users navigate the codebase, build configuration and any related assets. + +| File/folder | Description | +|-------------------|--------------------------------------------| +| `src` | Sample source code. | +| `.gitignore` | Define what to ignore at commit time. | +| `CHANGELOG.md` | List of changes to the sample. | +| `CONTRIBUTING.md` | Guidelines for contributing to the sample. | +| `README.md` | This README file. | +| `LICENSE` | The license for the sample. | + +## Prerequisites + +Outline the required components and tools that a user might need to have on their machine in order to run the sample. This can be anything from frameworks, SDKs, OS versions or IDE releases. + +## Setup + +Explain how to prepare the sample once the user clones or downloads the repository. The section should outline every step necessary to install dependencies and set up any settings (for example, API keys and output folders). + +## Running the sample + +Outline step-by-step instructions to execute the sample and see its output. Include steps for executing the sample from the IDE, starting specific services in the Azure portal or anything related to the overall launch of the code. + +## Key concepts + +Provide users with more context on the tools and services used in the sample. Explain some of the code that is being used and how services interact with each other. + +## Contributing + +This project welcomes contributions and suggestions. Most contributions require you to agree to a +Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us +the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com. + +When you submit a pull request, a CLA bot will automatically determine whether you need to provide +a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions +provided by the bot. You will only need to do this once across all repos using our CLA. + +This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/). +For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or +contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.