Skip to content

Commit 75b59ea

Browse files
committed
platformio updates
1 parent 333a4f6 commit 75b59ea

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

docs/simplefoc_library/installation/library_platformio.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Using SimpleFOC from PlatformIO is not hard at all! The following instructions s
1818
- First, install [Visual Studio Code](https://code.visualstudio.com/download)
1919
- Run Visual Studio Code, and install PlatformIO using the Extensions Manager:
2020

21-
<img src="extras/Images/platformio_screenshot1.png">
21+
<img src="extras/Images/platformio_screenshot1.png" class="width80">
2222
1. Select extension manager
2323
2. Enter "PlatformIO" in the search
2424
3. Choose PlatformIO extension from the list (should be the first result)
@@ -30,7 +30,7 @@ Congratulations, you're ready to start your first project!
3030

3131
To create a new project that uses SimpleFOC, use the following steps:
3232

33-
<img src="extras/Images/platformio_screenshot2.png">
33+
<img src="extras/Images/platformio_screenshot2.png" class="width80">
3434
1. Select the PlatformIO Menu on the left sidebar
3535
2. Choose Open to open the platformIO home screen
3636
3. Click "New Project"
@@ -49,16 +49,16 @@ At this point, if it is the first project you are creating for this board, Platf
4949

5050
When everything is finished installing, you should be presented with a view like this:
5151

52-
<img src="extras/Images/platformio_screenshot4.png">
52+
<img src="extras/Images/platformio_screenshot4.png" class="width80">
5353

5454
You can now add the SimpleFOC library to the project:
5555

56-
<img src="extras/Images/platformio_screenshot5.png">
56+
<img src="extras/Images/platformio_screenshot5.png" class="width80">
5757
1. Click on the PlatformIO icon, and choose "Libraries" from the Menu
5858
2. Enter "Simple FOC" in the search
5959
3. Click on the library
6060

61-
<img src="extras/Images/platformio_screenshot6.png">
61+
<img src="extras/Images/platformio_screenshot6.png" class="width80">
6262
1. Click on "Add Library" to display the "Add Library" wizard
6363

6464
<img src="extras/Images/platformio_screenshot7.png" class="width50">
@@ -71,7 +71,7 @@ Cool! The SimpleFOC library is now associated with your project.
7171

7272
Open the platformio.ini file in the root directory of your project. It should look something like this, depending on the board you chose:
7373

74-
```
74+
```ini
7575
; PlatformIO Project Configuration File
7676
;
7777
; Build options: build flags, source filter
@@ -87,15 +87,17 @@ platform = atmelsam
8787
board = mkrwifi1010
8888
framework = arduino
8989
lib_deps = askuric/Simple FOC@^2.2
90+
lib_archive = false
9091
```
9192

92-
Important!
93-
You have to add the line *lib_archive = false* to make SimpleFOC compile correctly with PlatformIO.
93+
<blockquote class='warning'>
94+
<p class='heading'>IMPORTANT! ⚠️</p>
95+
You have to add the line <code class='highlighter-rouge'>lib_archive = false</code> to make SimpleFOC compile correctly with PlatformIO.
96+
</blockquote>
9497

9598
You may also want to add some other options, like *monitor_speed* to set the serial port speed for debug output.
9699

97-
```
98-
lib_archive = false
100+
```ini
99101
monitor_speed = 115200
100102
```
101103

0 commit comments

Comments
 (0)