Skip to content

Commit

Permalink
Update docs for exmaples
Browse files Browse the repository at this point in the history
  • Loading branch information
MaJerle committed Jul 31, 2022
1 parent cb50ebd commit 1efbf0e
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions docs/examples/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Examples and demos

Various examples are provided for fast library evaluation on embedded systems. These are prepared and maintained for ``2`` platforms, but could be easily extended to more platforms:

* WIN32 examples, prepared as `Visual Studio Community <https://visualstudio.microsoft.com/vs/community/>`_ projects
* WIN32 examples, prepared as `CMake` projects, ready for `MSYS2 GCC compiler`
* ARM Cortex-M examples for STM32, prepared as `STM32CubeIDE <https://www.st.com/en/development-tools/stm32cubeide.html>`_ GCC projects. These are also supported in *Visual Studio Code* through *CMake* and *ninja* build system. `Dedicated tutorial <https://github.com/MaJerle/stm32-cube-cmake-vscode>`_ is available to get started in *VSCode*.

.. note::
Expand All @@ -20,8 +20,12 @@ Therefore it has been decided to support (for purpose of examples) ``2`` platfor
WIN32
*****

Examples for *WIN32* are prepared as `Visual Studio Community <https://visualstudio.microsoft.com/vs/community/>`_ projects.
You can directly open project in the IDE, compile & debug.
Examples for *WIN32* are CMake-ready and *VSCode*-ready.
It utilizes CMake-presets feature to let you select the example and compile it directly.

* Make sure you have installed GCC compiler and is in env path (you can get it through MSYS2 packet manager)
* Install ninja and cmake and make them available in the path (you can get all through MSYS2 packet manager)
* Go to *examples win32* folder, open vscode there or run cmd: ``cmake --preset <project name>`` to configure cmake and later ``cmake --build --preset <project name>`` to compile the project

Application opens *COM* port, set in the low-level driver.
External USB to UART converter (FTDI-like device) is necessary in order to connect to *ESP* device.
Expand Down

0 comments on commit 1efbf0e

Please sign in to comment.