CCF/README.md

# The Confidential Consortium Framework [![Docs](https://img.shields.io/badge/Documentation-Up%20to%20date-green)](https://microsoft.github.io/CCF)

<img alt="ccf" align="right" src="doc/_static/ccf.svg" width="200">

- Continuous Build: [![Build Status](https://dev.azure.com/MSRC-CCF/CCF/_apis/build/status/CCF%20Github%20CI?branchName=main)](https://dev.azure.com/MSRC-CCF/CCF/_build/latest?definitionId=3&branchName=main)
- Daily Build: [![Build Status](https://dev.azure.com/MSRC-CCF/CCF/_apis/build/status/CCF%20GitHub%20Daily?branchName=main)](https://dev.azure.com/MSRC-CCF/CCF/_build/latest?definitionId=7&branchName=main)
- Doc Build: [![docs](https://dev.azure.com/MSRC-CCF/CCF/_apis/build/status/CCF%20GitHub%20Pages?branchName=main)](https://dev.azure.com/MSRC-CCF/CCF/_build/latest?definitionId=4&branchName=main)
- Containers: [![Build and Publish Release Containers](https://github.com/microsoft/CCF/actions/workflows/containers.yml/badge.svg)](https://github.com/microsoft/CCF/actions/workflows/containers.yml)

The [Confidential Consortium Framework (CCF)](https://ccf.dev/) is an open-source framework for building a new category of secure, highly available,
and performant applications that focus on multi-party compute and data.

## Get Started with CCF

- Read the [CCF overview](https://ccf.microsoft.com/) and get familiar with [CCF's core concepts](https://microsoft.github.io/CCF/main/overview/what_is_ccf.html)
- [Install](https://microsoft.github.io/CCF/main/build_apps/install_bin.html) CCF on Linux
- Get familiar with CCF core developer API with the [template CCF app](https://github.com/microsoft/ccf-app-template)
- Quickly build and run [sample CCF apps](https://github.com/microsoft/ccf-app-samples)
- [Build new CCF applications](https://microsoft.github.io/CCF/main/build_apps/index.html) in TypeScript/JavaScript or C++

## Contribute

- [Contribute](https://microsoft.github.io/CCF/main/contribute) to this repository, following the [contribution guidelines](.github/CONTRIBUTING.md)
- Submit [bugs](https://github.com/microsoft/CCF/issues/new?assignees=&labels=bug&template=bug_report.md&title=) and [feature requests](https://github.com/microsoft/CCF/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=)
- Start a [discussion](https://github.com/microsoft/CCF/discussions/new) to ask a question or propose an idea

## Learn More

- Browse the [documentation](https://microsoft.github.io/CCF/)
- Read the [Research Papers](https://microsoft.github.io/CCF/main/research)
- Learn more about [Azure Confidential Computing](https://azure.microsoft.com/solutions/confidential-compute/) offerings like Azure DC-series (which support Intel SGX TEE) and the [Open Enclave](https://github.com/openenclave/openenclave) SDK

## Third-party components

We rely on several open source third-party components, attributed under [THIRD_PARTY_NOTICES](THIRD_PARTY_NOTICES.txt).

## Contributing

This project welcomes contributions and suggestions. Please see the [Contribution guidelines](.github/CONTRIBUTING.md).
Fix README layout (#3977) 2022-06-24 11:34:30 +03:00			`# The Confidential Consortium Framework [![Docs](https://img.shields.io/badge/Documentation-Up%20to%20date-green)](https://microsoft.github.io/CCF)`
Add CI badge (#24) 2019-05-03 19:24:33 +03:00
Update repo/docs branding in line with new website (#4373) 2022-10-20 12:43:29 +03:00			`<img alt="ccf" align="right" src="doc/_static/ccf.svg" width="200">`
Update README.md (#2147) 2021-02-02 13:56:40 +03:00
Fix README layout (#3977) 2022-06-24 11:34:30 +03:00			`- Continuous Build: [![Build Status](https://dev.azure.com/MSRC-CCF/CCF/_apis/build/status/CCF%20Github%20CI?branchName=main)](https://dev.azure.com/MSRC-CCF/CCF/_build/latest?definitionId=3&branchName=main)`
			`- Daily Build: [![Build Status](https://dev.azure.com/MSRC-CCF/CCF/_apis/build/status/CCF%20GitHub%20Daily?branchName=main)](https://dev.azure.com/MSRC-CCF/CCF/_build/latest?definitionId=7&branchName=main)`
			`- Doc Build: [![docs](https://dev.azure.com/MSRC-CCF/CCF/_apis/build/status/CCF%20GitHub%20Pages?branchName=main)](https://dev.azure.com/MSRC-CCF/CCF/_build/latest?definitionId=4&branchName=main)`
			`- Containers: [![Build and Publish Release Containers](https://github.com/microsoft/CCF/actions/workflows/containers.yml/badge.svg)](https://github.com/microsoft/CCF/actions/workflows/containers.yml)`
Update README.md (#1133) 2020-05-04 16:16:20 +03:00
Update repo/docs branding in line with new website (#4373) 2022-10-20 12:43:29 +03:00			`The [Confidential Consortium Framework (CCF)](https://ccf.dev/) is an open-source framework for building a new category of secure, highly available,`
Update readme (#1270) 2020-06-10 21:02:42 +03:00			`and performant applications that focus on multi-party compute and data.`
Update README.md (#13) 2019-05-01 22:13:25 +03:00
Update readme (#1843) 2020-10-30 16:30:48 +03:00			`## Get Started with CCF`
Update README.md (#13) 2019-05-01 22:13:25 +03:00
Update repo/docs branding in line with new website (#4373) 2022-10-20 12:43:29 +03:00			`- Read the [CCF overview](https://ccf.microsoft.com/) and get familiar with [CCF's core concepts](https://microsoft.github.io/CCF/main/overview/what_is_ccf.html)`
Add references to `ccf-app-template` repository (#4210) 2022-09-12 11:33:14 +03:00			`- [Install](https://microsoft.github.io/CCF/main/build_apps/install_bin.html) CCF on Linux`
Install CCF on AzureVM (#4502) 2022-11-11 00:00:54 +03:00			`- Get familiar with CCF core developer API with the [template CCF app](https://github.com/microsoft/ccf-app-template)`
			`- Quickly build and run [sample CCF apps](https://github.com/microsoft/ccf-app-samples)`
Replaces references to master with references to main (#2171) 2021-02-05 14:32:19 +03:00			`- [Build new CCF applications](https://microsoft.github.io/CCF/main/build_apps/index.html) in TypeScript/JavaScript or C++`
Update repo/docs branding in line with new website (#4373) 2022-10-20 12:43:29 +03:00
			`## Contribute`

Replaces references to master with references to main (#2171) 2021-02-05 14:32:19 +03:00			`- [Contribute](https://microsoft.github.io/CCF/main/contribute) to this repository, following the [contribution guidelines](.github/CONTRIBUTING.md)`
Make what we can prettier (#1862) 2020-11-10 13:57:56 +03:00			`- Submit [bugs](https://github.com/microsoft/CCF/issues/new?assignees=&labels=bug&template=bug_report.md&title=) and [feature requests](https://github.com/microsoft/CCF/issues/new?assignees=&labels=enhancement&template=feature_request.md&title=)`
Update README.md (#2147) 2021-02-02 13:56:40 +03:00			`- Start a [discussion](https://github.com/microsoft/CCF/discussions/new) to ask a question or propose an idea`
Update README.md Initial README improvements 2019-04-26 19:06:43 +03:00
Update readme (#1843) 2020-10-30 16:30:48 +03:00			`## Learn More`
Update README.md Initial README improvements 2019-04-26 19:06:43 +03:00
Make what we can prettier (#1862) 2020-11-10 13:57:56 +03:00			`- Browse the [documentation](https://microsoft.github.io/CCF/)`
Update docs with research link (#2629) 2021-06-01 13:39:31 +03:00			`- Read the [Research Papers](https://microsoft.github.io/CCF/main/research)`
Make what we can prettier (#1862) 2020-11-10 13:57:56 +03:00			`- Learn more about [Azure Confidential Computing](https://azure.microsoft.com/solutions/confidential-compute/) offerings like Azure DC-series (which support Intel SGX TEE) and the [Open Enclave](https://github.com/openenclave/openenclave) SDK`
Update README.md Initial README improvements 2019-04-26 19:06:43 +03:00
			`## Third-party components`

			`We rely on several open source third-party components, attributed under [THIRD_PARTY_NOTICES](THIRD_PARTY_NOTICES.txt).`

			`## Contributing`

Update Contribution section (#1365) 2020-07-01 15:56:49 +03:00			`This project welcomes contributions and suggestions. Please see the [Contribution guidelines](.github/CONTRIBUTING.md).`