diff --git a/README.md b/README.md index 95e03ab5e..9c024ed21 100644 --- a/README.md +++ b/README.md @@ -12,8 +12,9 @@ and performant applications that focus on multi-party compute and data. ## Get Started with CCF -- [Install](https://microsoft.github.io/CCF/main/build_apps/install_bin.html) CCF on Linux +- Quickly build and run the [sample CCF application](https://github.com/microsoft/ccf-app-template) - Read a [short overview of CCF](https://microsoft.github.io/CCF/main/overview/what_is_ccf.html) and get familiar with CCF's core concepts +- [Install](https://microsoft.github.io/CCF/main/build_apps/install_bin.html) CCF on Linux - [Build new CCF applications](https://microsoft.github.io/CCF/main/build_apps/index.html) in TypeScript/JavaScript or C++ - [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=) diff --git a/doc/build_apps/index.rst b/doc/build_apps/index.rst index 2afed97ef..4344ac7ca 100644 --- a/doc/build_apps/index.rst +++ b/doc/build_apps/index.rst @@ -3,6 +3,8 @@ Build Apps This section describes how CCF applications can be developed and deployed to a CCF network. +.. tip:: The `ccf-app-template `_ repository can be used to quickly build and run a sample CCF application and provides a minimal template to create new CCF apps. + Applications can be written in JavaScript/TypeScript or C++. An application consists of a collection of endpoints that can be triggered by :term:`Users`. Each endpoint can define an :ref:`build_apps/example_cpp:API Schema` to validate user requests. These endpoints can read or mutate the state of a unique :ref:`build_apps/kv/index:Key-Value Store` that represents the internal state of the application. Applications define a set of ``Maps`` (see :doc:`kv/kv_how_to`), mapping from a key to a value. When an application endpoint is triggered, the effects on the Store are committed atomically. @@ -85,7 +87,7 @@ These endpoints can read or mutate the state of a unique :ref:`build_apps/kv/ind :fa:`rocket` :doc:`release_policy` ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ - CCF release cadence and compatibility committments. + CCF release cadence and compatibility commitments. .. toctree:: diff --git a/doc/build_apps/install_bin.rst b/doc/build_apps/install_bin.rst index 6eef878e2..855b2acc7 100644 --- a/doc/build_apps/install_bin.rst +++ b/doc/build_apps/install_bin.rst @@ -1,6 +1,8 @@ Install CCF =========== +.. tip:: The `ccf-app-template `_ repository can be used to quickly setup the environment necessary to build CCF apps. + Requirements ------------