Skip to content

Commit 2f4752b

Browse files
authored
Merge pull request #340 from asherevan/patch-1
Fix some stuff in README.md
2 parents 246acc2 + 41d261f commit 2f4752b

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

README.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,13 @@ related bits of a microcontroller.
3232

3333
***What is LVGL?***
3434

35-
[LVGL](https://lvgl.io) is a graphics framework writtemn for C99. It is also written to run on resource constrained devices.
35+
[LVGL](https://lvgl.io) is a graphics framework written for C99. It is also written to run on resource constrained devices.
3636
It is a feature rich framework that provides a plethora of different controls (widgets) as well as the ability
3737
to make your owmn custom controls.
3838

3939
***What is a binding?***
4040

41-
A Binding is a code that encapsulates code written in one programming language so it is accessable from another
41+
A Binding is code that encapsulates code written in one programming language so it is accessable from another
4242
programming language. It is best to think of it as a translator, in the case of this project it translates Python
4343
to C99 and vice versa. It allows us access to the LVGL code by using the Python programming language.
4444

@@ -278,7 +278,7 @@ To compile you will need Python >= 3.10 for for all build types.
278278

279279
#### Compiling for Windows:
280280

281-
* not supported yet
281+
* Not yet supported
282282

283283
<br>
284284

@@ -331,7 +331,7 @@ Target options is broken down into 2 sections
331331

332332
##### *Model/Variant*
333333

334-
The model is the processor model being used or the build type. the build type is what is
334+
The model is the processor model being used or the build type. The build type is what is
335335
specified when compiling to run on macOS or Unix.
336336

337337
When compiling for macOS or Unix you are able to specify the build type. That is done by using
@@ -549,9 +549,9 @@ ______________________________________
549549

550550
Common options that are available across all esp32 targets:
551551

552-
* `BAUD={bits per second}`: how fast to flash the firmware, `deploy` must also be set to use this
553-
* `PORT={serial port}`: port the ESP is connected to, `deploy` must also be set to use this
554-
* `deploy`: after building flash the firmware, `PORT` and `BAUD` are optional. The speed will default
552+
* `BAUD={bits per second}`: How fast to flash the firmware, `deploy` must also be set to use this
553+
* `PORT={serial port}`: Port the ESP is connected to, `deploy` must also be set to use this
554+
* `deploy`: After building flash the firmware, `PORT` and `BAUD` are optional. The speed will default
555555
to whatever the ESP-IDF is set to and there will be an attempt at detecting the port automatically
556556
* `--skip-partition-resize`: If you do not want the build system to resize the application partition automatically.
557557
* `--partition-size={app partition size}`: Manually set the application partition size. This is something you want
@@ -566,8 +566,8 @@ Common options that are available across all esp32 targets:
566566
* `--flash-size={4, 8, 16, 32, 64 or 128}`: Sets the flash size that you have available on your ESP32
567567
* `--ota`: Add this flag if you wanbt to do OTA updates. This creates 2 application partitions that are the same size.
568568
* `--dual-core-threads`: (Experimental) MicroPython is written so that the user is only able to run code on a single core of the ESP32.
569-
That is very limiting. This option allows code to run on both CPU cores. Be warned mthis option also disables the GIL
570-
So care must be given to accessing global variables. You need to put nlocks in place to keep the memory from getting
569+
That is very limiting. This option allows code to run on both CPU cores. Be warned this option also disables the GIL
570+
so care must be given to accessing global variables. You need to put nlocks in place to keep the memory from getting
571571
corrupted. You do not get to decide what core to use. That is automatically done based on the load that is on the cores.
572572
* `--task-stack-size={stack size in bytes}`: Sets the default stack size for threads
573573
* `CONFIG_*={value}`: You can alter the config settings of the esp-idf by using these settings. Refer to the ESP-IDF documentation
@@ -606,10 +606,10 @@ The global options are broken down into 2 secions
606606

607607
##### *Input/Output*
608608

609-
* `DISPLAY={ic model or path}`: model number of the display driver that is located in `api_drivers/common_api_drivers/display`
609+
* `DISPLAY={ic model or path}`: Model number of the display driver that is located in `api_drivers/common_api_drivers/display`
610610
or it can be the absolute path to a custom driver you have written. This must be the
611611
path to the folder that contains the driver files.
612-
* `INDEV={ic model or path}`: model number of indev driver that is located in `api_drivers/common_api_drivers/indev`
612+
* `INDEV={ic model or path}`: Model number of indev driver that is located in `api_drivers/common_api_drivers/indev`
613613
or it can be the absolute path to your own custom driver (with the .py extension)
614614

615615
The above options are able to be repeated if you want to include multiple drivers.

0 commit comments

Comments
 (0)