Improve documemntation

[JaviVilarroig]

Is your feature request related to a problem?

I have been unable to find a clear explanation of how to deploy the espp component in my idf development environment.

Has this library been added to the Espressif Compnent register? I have been unable to find it.

It will be nice if the documentation starts with a little chapter explaining how to deploy the library.

Thanks!

Describe the solution you'd like.

No response

Describe alternatives you've considered.

No response

Additional context.

No response

[finger563]

Hey @JaviVilarroig thanks for opening this issue - updating the documentation has def. been on my todo-list, so thanks for poking me about it 😅

I'll make some updates to the documentation shortly, but really quick to answer your question and provide some help until then:

First, you must have ESP-IDF >= v5.2. Much of the code was developed targeting 5.0, but a few changes came through (and fixes of course) which mean (I believe) that you must use 5.2. It's been a few months since i've tested anything not 5.2, so it may work on say 5.1 or 5.3, but I've not had a chance to test against it yet (and I've not set up the CI to build against it for testing yet either).

You have a couple of options:

1. You can use the esp-cppp/template repository as a starting point, which is very similar to the esp-idf template, but is geared towards c++ development and already has espp as a submodule, along with the appropriate configuration in the top-level CMakeLists.txt.
2. If you have an existing project with a components directory, then you can clone espp as a submodule within that directory e.g. git submodule add https://github.com/esp-cpp/espp components/espp, then make sure to run git submodule update --init --recursive. Afterwards, simply update your CMakeLists.txt to add

# add the component directories that we want to use
set(EXTRA_COMPONENT_DIRS
  "components/espp/components"
)

3. You can clone espp somewhere on your computer and then point your project to its components directory to use any of the components it contains, similar to the step above.

The mention about the idf component registry is a good one - I don't personally use it much (preferring to use git submodules instead), but I'll add it as a todo to publish this as an idf-component so that its easier for others who use the registry to integrate into their projects.

Hope that helps, and def. let me know if you have any questions or run into any issues!

[JaviVilarroig]

Hi @finger563

Thanks for the fast answer :)

Any of the three answers looks OK, thanks :) I will try when I have a minute.

I really think is good to try the component registry, because it has a good integration with the idf environment and most newbies in the ESP32 world, like me, will go there first.

I my case I was already starting to develop my own library because I didn't found anything similar in the registry. I found this one when I was checking if the name espp was already taken in a search engine. :smile:

Thanks again!