Skip to content

Commit 759d97d

Browse files
authored
Added images and video to readme.md
1 parent 08dff7f commit 759d97d

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

README.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ This project transform VS Code to a great IDE that can be used with STM32CubeMX
88

99
Debug capabilities are somehow limited, but can be good enough for most simple projects - see below.
1010

11+
[![VS Code as STM32 IDE](http://img.youtube.com/vi/rWjb43kLHdQ/0.jpg)](https://www.youtube.com/watch?v=rWjb43kLHdQ)
12+
1113
## How does it work?
1214
Scripts generate all necessary VS Code workspace files ('c_cpp_properties.json', 'tasks.json' and 'launch.json') that IDE needs for autocomplete and compile/build/debug/download actions. New 'Makefile' is generated from CubeMX and user data on each update. All user settings are stored and can be changed in one file: 'c_cpp_properties.json'.
1315

@@ -34,7 +36,8 @@ This is needed for debug purposes and workspace file generation scripts.
3436
This file is (recommended by ST) downloaded from [Keil official page](https://www.keil.com/dd2/pack/). Just search for your chosen STM32 CPU family (ex.: STM32F0...), download and unpack with any archive software.
3537
I recommend to unpack it in the same directory as other GNU Eclipse tools (eg: *%userprofile%\AppData\Roaming\GNU MCU Eclipse*) so everything is neatly organised in one place and files can be reused in other projects (this files will not be changed).
3638

37-
At the end, folder structure should look like this: TODO IMAGE
39+
At the end, folder structure should look like this:
40+
![Folder structure](https://github.com/damogranlabs/VS-Code-STM32-IDE/blob/master/_images/folderStructure.PNG)
3841

3942
# First steps
4043
Once all prerequisites are installed, work flow is very simple.
@@ -64,8 +67,9 @@ Scripts generate following tasks, which should work out of the box.
6467
* Reset and run CPU (do not download code, execute reset and run CPU without attaching debugger)
6568
* Stop CPU
6669
* Run CPU
70+
71+
![Tasks](https://github.com/damogranlabs/VS-Code-STM32-IDE/blob/master/_images/tasks.PNG)
6772

68-
TODO IMAGE
6973

7074
## Debug
7175
Two launch (debug) configurations are currently implemented automatically in 'launch.json': debug embedded project and selected python
@@ -80,11 +84,10 @@ Debug capabilities are currently slightly limited (*Cortex-Debug* extension), bu
8084
* more than available breakpoints can be set (OpenOCD shows number of available BPs at the beginning)
8185
* after reset, location is not refreshed.
8286

83-
Anyway, any non-beginner shouldn't have much problems with this limitations.
84-
85-
TODO IMAGE
87+
Anyway, any non-beginner shouldn't have much problems with this limitations.
88+
![Launch configurations](https://github.com/damogranlabs/VS-Code-STM32-IDE/blob/master/_images/launchConfigurations.PNG)
8689

8790

8891
## Even more?
89-
Need to know more details? see 'README_DETAILS.md'.
90-
Suggestions, details, ideas, bugs? Use Issues tab.
92+
Need to know more details? see [README_DETAILS.md](https://github.com/damogranlabs/VS-Code-STM32-IDE/blob/master/README_DETAILS.md).
93+
Suggestions, details, ideas, bugs? Use [Issues tab](https://github.com/damogranlabs/VS-Code-STM32-IDE/issues).

0 commit comments

Comments
 (0)