docs: Update docs with iOS app reference and added Github actions badges

Also, changed '. export.sh' to 'source export.sh' because people often
gets confused and executes the script which is supposed to be sourced.
This commit is contained in:
Shubham Patil
2023-01-23 10:01:41 +05:30
parent 2a7cf01fde
commit 2a7abbb679
5 changed files with 13 additions and 8 deletions
+1 -1
View File
@@ -12,7 +12,7 @@
# See the License for the specific language governing permissions and
# limitations under the License.
name: Docker Image CI
name: Build Docker
on:
push:
+2 -2
View File
@@ -15,11 +15,11 @@
# This workflow build examples, store the artifacts and deploy them to github pages.
# Generates the launchpad configuration file that can be used with the url.
name: Build and Deploy example bins to github pages
name: Build Examples
on:
workflow_run:
workflows: ["Docker Image CI"]
workflows: ["Build Docker"]
types: [completed]
# Allows you to run this workflow manually from the Actions tab
+3
View File
@@ -1,5 +1,8 @@
# Espressif's SDK for Matter
[![Docker Image](https://github.com/espressif/esp-matter/actions/workflows/docker-image.yml/badge.svg)](https://github.com/espressif/esp-matter/actions/workflows/docker-image.yml)
[![Launchpad Deployment](https://github.com/espressif/esp-matter/actions/workflows/pages.yml/badge.svg)](https://github.com/espressif/esp-matter/actions/workflows/pages.yml)
## Introduction
Espressif's SDK for Matter is the official Matter development framework for ESP32 series SoCs. It is built on top of the [open source Matter SDK](https://github.com/project-chip/connectedhomeip/), and provides simplified APIs, commonly used peripherals, tools and utilities for security, manufacturing and production accompanied by exhaustive documentation. It includes rich production references, aimed to simplify the development process of Matter products and enable the users to go to production in the shortest possible time.
+6 -4
View File
@@ -54,7 +54,7 @@ For using VSCode for developement, please check `Developing in WSL <https://code
git clone --recursive https://github.com/espressif/esp-idf.git
cd esp-idf; git checkout v4.4.2; git submodule update --init --recursive;
./install.sh
. ./export.sh
source ./export.sh
cd ..
.. only:: esp32h2
@@ -64,7 +64,7 @@ For using VSCode for developement, please check `Developing in WSL <https://code
git clone --recursive https://github.com/espressif/esp-idf.git
cd esp-idf; git checkout 20949d444f; git submodule update --init --recursive;
./install.sh
. ./export.sh
source ./export.sh
cd ..
Cloning the esp-matter repository takes a while due to a lot of submodules in the upstream connectedhomeip,
@@ -107,8 +107,8 @@ This should be done each time a new terminal is opened
::
cd esp-idf; . ./export.sh; cd ..
cd esp-matter; . ./export.sh; cd ..
cd esp-idf; source ./export.sh; cd ..
cd esp-matter; source ./export.sh; cd ..
Enable Ccache for faster IDF builds.
@@ -197,6 +197,8 @@ There are a few implementations of Matter commissioner present in the `connected
CHIP Tool is an example implementation of Matter commissioner and used for development purposes.
Espressif also has an iOS application, `Espressif-Matter <https://apps.apple.com/in/app/espressif-matter/id1604739172>`__, to commission and control the Matter devices. Please follow `profile installation instructions <https://github.com/project-chip/connectedhomeip/blob/master/docs/guides/darwin.md#profile-installation>`__ in order to use the application.
2.2.1 Test Setup (CHIP Tool)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+1 -1
View File
@@ -77,8 +77,8 @@ do
# Write the esp-matter phone app links
# TODO: Update the phone app links when they are available on android play store and apple app store
echo "ios_app_url = \"https://apps.apple.com/in/app/espressif-matter/id1604739172\"" >> $OUT_FILE
echo "android_app_url = \"\"" >> $OUT_FILE
echo "ios_app_url = \"\"" >> $OUT_FILE
echo "" >> $OUT_FILE
unset CHIPSETS IMAGES