Update to use idf-component-manager instead of espp submodule, removing the need for a submodule. Update docs accordingly

Author: finger563

.gitignore

@@ -33,3 +33,4 @@
 build/
 sdkconfig
 sdkconfig.old
+managed_components/

.gitmodules

@@ -1,3 +0,0 @@
-[submodule "components/espp"]
-	path = components/espp
-	url = git@github.com:esp-cpp/espp

CMakeLists.txt

@@ -7,13 +7,32 @@ include($ENV{IDF_PATH}/tools/cmake/project.cmake)
 # add the component directories that we want to use
 set(EXTRA_COMPONENT_DIRS
   "components/"
-  "components/espp/components/"
+  # NOTE: if we didn't use the idf-component-manager to get the espp
+  #       dependencies, we could instead have ESPP be a submodule within our
+  #       'components' folder, which would mean we'd need to add it to the DIRS:
+  #
+  # "components/espp/components/"
+  #
+  # NOTE: alternatively, we could install espp system-wide, so we could just
+  #       point it to wherever we have espp installed.
+  #
+  # "/path/to/espp/components/"
 )
 
 set(
   COMPONENTS
-  # TODO: add additional esp-idf and espp components you want to use to the line below:
-  "main esptool_py logger task"
+  # NOTE: you can add additional esp-idf and espp components you want to use to
+  #       the line below.
+  #
+  # Alternatively, If they exist in the component registry, then you can ignore
+  # adding them here, and instead use call
+  #
+  # `idf.py add-dependency "<namespace>/<component>^<version>"`
+  #
+  # e.g.
+  #
+  # `idf.py add-dependency "espp/task^0.21.0"`
+  "main esptool_py"
   CACHE STRING
   "List of components to include"
   )

README.md

@@ -3,17 +3,34 @@
 Template repository for building an ESP app with ESP++ (espp) components and
 ESP-IDF components.
 
+<!-- markdown-toc start - Don't edit this section. Run M-x markdown-toc-refresh-toc -->
+**Table of Contents**
+
+- [ESP++ Template](#esp-template)
+  - [Development](#development)
+  - [Build and Flash](#build-and-flash)
+  - [Output](#output)
+  - [Developing](#developing)
+    - [Code style](#code-style)
+
+<!-- markdown-toc end -->
+
 ## Development
 
 This repository is designed to be used as a template repository - so you can
 sepcify this as the template repository type when creating a new repository on
 GitHub.
 
 After setting this as the template, make sure to update the following:
-- [This README](./README.md) to contain the relevant description and images of your project
-- The [./CMakeLists.txt](./CMakeLists.txt) file to have the components that you
-  want to use (and any you may have added to the [components
-  folder](./components)) as well as to update the project name
+- [This README](./README.md) to contain the relevant description and images of
+  your project
+- Add additional component dependencies you may want, e.g.:
+
+    ```console
+    idf.py add-dependency "espp/timer^0.21.0"
+    ```
+
+- The [./CMakeLists.txt](./CMakeLists.txt) file to update the project name.
 - The [./main/main.cpp](./main/main.cpp) To run the main code for your app. The
   [main folder](./main) is also where you can put additional header and source
   files that you don't think belong in their own components but help keep the
@@ -27,22 +44,6 @@ After setting this as the template, make sure to update the following:
   analysis tool to put its results into a comment on any pull requests in your
   repository.
 
-## Cloning
-
-Since this repo contains a submodule, you need to make sure you clone it
-recursively, e.g. with:
-
-``` sh
-git clone --recurse-submodules <your repo name>
-```
-
-Alternatively, you can always ensure the submodules are up to date after cloning
-(or if you forgot to clone recursively) by running:
-
-``` sh
-git submodule update --init --recursive
-```
-
 ## Build and Flash
 
 Build the project and flash it to the board, then run monitor tool to view serial output:

components/espp

@@ -0,0 +1,17 @@
+## IDF Component Manager Manifest File
+dependencies:
+  ## Required IDF version
+  idf:
+    version: '>=4.1.0'
+  # # Put list of dependencies here
+  # # For components maintained by Espressif:
+  # component: "~1.0.0"
+  # # For 3rd party components:
+  # username/component: ">=1.0.0,<2.0.0"
+  # username2/component2:
+  #   version: "~1.0.0"
+  #   # For transient dependencies `public` flag can be set.
+  #   # `public` flag doesn't have an effect dependencies of the `main` component.
+  #   # All dependencies of `main` are public by default.
+  #   public: true
+  espp/task: ^0.21.0