hihigupt/azure-sdk-for-c

Microsoft Azure SDK for Embedded C

Azure SDK for Embedded C

This repository contains official Embedded C libraries for Azure services.

Getting started

To get started with a specific library, see the README.md file located in the library's project folder. You can find service libraries in the /sdk directory.

Prerequisites

• CMake version 3.12 is required to use these libraries.

Development Environment

Project contains files to work on Windows or Linux based OS.

Note: Project contains git submodules required to build. Before building run git submodule update --init --recursive

Windows

Use PowerShell to run {projectDir}/build.ps1

Note: Cmake will look for CURL within windows. Follow next steps to set up CURL using VCPKG:
- Clone vcpgk: git clone https://github.com/Microsoft/vcpkg.git
- cd vcpkg (consider this path as PATH_TO_VCPKG)
- .\bootstrap-vcpkg.bat
- vcpkg.exe install --triplet x64-windows-static curl[winssl]
- Add windows system variable: VCPKG_DEFAULT_TRIPLET=x64-windows-static
- Add windows system variable: VCPKG_ROOT=[PATH_TO_VCPKG] (replace PATH_TO_VCPKG for where vcpkg is installed)

Visual Studio 2019

When following previous steps to set up CURL with VCPKG, open project forlder with Visual Studio and everything will be ready to build and run tests.

Linux

• Install openssl version 1.1.1
  • For ubuntu: sudo apt-get install libssl-dev
• Install uuid
  • sudo apt-get install uuid-dev

steps to build

mkdir build
cd build
cmake ../
make

Note: use cmake -Duse_default_uuid=ON ../ if no uuid-dev is installed in system

Build Docs

Running below command from root folder will create a new folder docs containing html file with documentation about CORE headers.

doxygen needs to be installed in the system

doxygen Doxyfile

Need help?

• File an issue via Github Issues.
• Check previous questions or ask new ones on StackOverflow using the azure and c tags.

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 repositories 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.

Additional Helpful Links for Contributors

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

• What are some good first issues for new contributors to the repo?
• How to build and test your change
• How you can make a change happen!
• Frequently Asked Questions (FAQ) and Conceptual Topics in the detailed Azure SDK for C wiki.

Community

• Chat with other community members

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.