Skip to content

Commit 694d731

Browse files
authored
Update README.md
1 parent c294549 commit 694d731

File tree

1 file changed

+14
-10
lines changed

1 file changed

+14
-10
lines changed

README.md

+14-10
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,28 @@
11
# CCF App Template
22

3-
[![Try me out](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=496290904&machine=basicLinux32gb&devcontainer_path=.devcontainer.json&location=WestEurope)
3+
[![Open in VSCode](https://img.shields.io/static/v1?label=Open+in&message=VSCode&logo=visualstudiocode&color=007ACC&logoColor=007ACC&labelColor=2C2C32)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/ccf-app-template)
44

55
[![CCF App Template CI](https://github.com/microsoft/ccf-app-template/actions/workflows/ci.yml/badge.svg)](https://github.com/microsoft/ccf-app-template/actions/workflows/ci.yml)
66

77
Template repository for CCF applications.
88

99
## Quickstart
1010

11-
**The quickest way to build and run this sample CCF app is to create a GitHub codespace by clicking [here](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=496290904&machine=basicLinux32gb&devcontainer_path=.devcontainer.json&location=WestEurope).**
11+
**The quickest way to build and run this sample CCF app is to checkout this repository locally in its development container by clicking:
12+
[![Open in VSCode](https://img.shields.io/static/v1?label=Open+in&message=VSCode&logo=visualstudiocode&color=007ACC&logoColor=007ACC&labelColor=2C2C32)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/microsoft/ccf-app-template)**
13+
14+
All dependencies will be automatically installed (takes ~2 mins on first checkout) and the app can be quickly [built](#build) and [run](#run) by following [the steps below](#build).
1215

13-
All dependencies will be automatically installed and the application can be quickly [built](#build) and [run](#run) by following the steps below.
1416

1517
Also check out the [code tour](#code-tour) to get an overview of the app.
1618

19+
Alternatively, if your organisation supports it, you can checkout this repository in a Github Codespace: [![Open in Github codespace](https://img.shields.io/static/v1?label=Open+in&message=GitHub+codespace&logo=github&color=2F363D&logoColor=white&labelColor=2C2C32)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=496290904&machine=basicLinux32gb&devcontainer_path=.devcontainer.json&location=WestEurope)
20+
1721
---
1822

1923
## Build
2024

21-
In the local checkout of this repository:
25+
In the checkout of this repository:
2226

2327
```bash
2428
$ mkdir build && cd build
@@ -47,7 +51,7 @@ Python environment successfully setup
4751
[12:00:00.000] Press Ctrl+C to shutdown the network
4852
```
4953

50-
Or, for an SGX-enabled application (unavailable in Github codespace): `$ /opt/ccf/bin/sandbox.sh -p ./libccf_app.enclave.so.signed -e release`
54+
Or, for an SGX-enabled application (unavailable in development container): `$ /opt/ccf/bin/sandbox.sh -p ./libccf_app.enclave.so.signed -e release`
5155

5256
In another terminal:
5357

@@ -72,17 +76,17 @@ $ docker run --device /dev/sgx_enclave:/dev/sgx_enclave --device /dev/sgx_provis
7276

7377
## Dependencies
7478

75-
If this repository is checked out on a bare VM (e.g. for SGX deployments), the dependencies required to build and run the CCF app can be installed as follows:
79+
If this repository is checked out on a bare VM (e.g. [for SGX deployments](https://docs.microsoft.com/en-us/azure/confidential-computing/quick-create-portal)), the dependencies required to build and run the CCF app can be installed as follows:
7680

7781
```bash
78-
$ wget https://github.com/microsoft/CCF/releases/download/ccf-2.0.0/ccf_2.0.0_amd64.deb
79-
$ sudo dpkg -i ccf_2.0.0_amd64.deb # Install CCF under /opt/ccf
82+
$ wget https://github.com/microsoft/CCF/releases/download/ccf-2.0.0/ccf_2.0.7_amd64.deb
83+
$ sudo dpkg -i ccf_2.0.7_amd64.deb # Install CCF under /opt/ccf
8084
$ cat /opt/ccf/share/VERSION_LONG
81-
ccf-2.0.0
85+
ccf-2.0.7
8286
$ /opt/ccf/getting_started/setup_vm/run.sh /opt/ccf/getting_started/setup_vm/app-dev.yml # Install dependencies
8387
```
8488

85-
Alternatively, you can checkout this repository in a [VSCode development container](https://code.visualstudio.com/docs/remote/containers).
89+
See the [CCF official docs](https://microsoft.github.io/CCF/main/build_apps/install_bin.html#install-ccf) for more info.
8690

8791
## Code Tour
8892

0 commit comments

Comments
 (0)