azure-sdk-for-cpp/sdk/template/azure-template
Anton Kolesnyk 50c18516df
Ensure CMakeLists don't miss any files (#5065)
* Ensure CMakeLists don't miss any files

---------

Co-authored-by: Anton Kolesnyk <antkmsft@users.noreply.github.com>
2023-10-26 18:15:03 -07:00
..
inc Ignore compiler and STL version mismatch on published packages to unblock ApiView (#4925) 2023-09-06 10:22:52 -07:00
src Use standard syntax for MIT license (#4786) 2023-07-12 22:37:36 -07:00
test Use standard syntax for MIT license (#4786) 2023-07-12 22:37:36 -07:00
vcpkg Shorten build-time paths when building in vcpkg (#4977) 2023-09-25 09:30:00 -07:00
CHANGELOG.md Set Template to unreleased in CHANGELOG.md (#4625) 2023-05-09 18:38:40 +00:00
CMakeLists.txt Ensure CMakeLists don't miss any files (#5065) 2023-10-26 18:15:03 -07:00
NOTICE.txt Update Notice and add cgmanifest.json (#839) 2020-11-18 11:44:22 -08:00
README.md Remove `LICENSE` file duplicates (#3085) 2021-11-09 15:55:14 -08:00
cgmanifest.json Add `$schema` to `cgmanifest.json` (#3918) 2022-09-13 08:50:38 -07:00
vcpkg.json Vcpkg manifest and binary caching (#3329) 2022-03-24 09:11:30 -07:00

README.md

Azure Template Package client library for C++

Azure Template Package client library for C++ (azure-template) matches necessary patterns that the development team has established to create a unified SDK written in the C++ programming language. These libraries follow the Azure SDK Design Guidelines for C++.

The library allows client libraries to expose common functionality in a consistent fashion. Once you learn how to use these APIs in one client library, you will know how to use them in other client libraries.

Getting started

For a rich example of a well formatted readme, please check here. In addition, this is an example readme that should be emulated. Note that the top-level sections in this template align with that of the template.

Key concepts

Bullet point list of your library's main concepts.

Examples

Examples of some of the key concepts for your library.

Troubleshooting

Running into issues? This section should contain details as to what to do there.

Next steps

More sample code should go here, along with links out to the appropriate example tests.

Contributing

For details on contributing to this repository, see the contributing guide.

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.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., label, 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. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.

Many people all over the world have helped make this project better. You'll want to check out:

Reporting security issues and security bugs

Security issues and bugs should be reported privately, via email, to the Microsoft Security Response Center (MSRC) secure@microsoft.com. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message. Further information, including the MSRC PGP key, can be found in the Security TechCenter.

License

Azure SDK for C++ is licensed under the MIT license.