Skip to content

Commit 6a24829

Browse files
authored
Update README.md
1 parent cbee69e commit 6a24829

File tree

1 file changed

+4
-23
lines changed

1 file changed

+4
-23
lines changed

README.md

Lines changed: 4 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -30,19 +30,16 @@ In order to get a head start with Inkplate (any), follow these steps:
3030
3. Install Inkplate Arduino library - Install the library from the Arduino Library Manager (just type "Inkplate" and click "Install") or install it with this repo. If you don't know how, check our [tutorial](https://soldered.com/learn/arduino-library/#Kako%20instaliraty%20library?).
3131
4. You are ready to get started! Select Tools -> Board -> Inkplate Boards and then pick correct one, as well as correct COM port and upload!
3232

33-
### Code examples
33+
### Code examples & LVGL Documentation
3434

35-
As this is currently a work in progress, only a small amount of examples are present, but more are coming very soon!
35+
As this is currently a work in progress, all examples except the 'project' Inkplate examples have been ported! The projects are coming soon.
36+
37+
To see the entire LVGL documentation, please check out the [official LVGL documentation](https://docs.lvgl.io/master/).
3638

3739
### Documentation
3840

3941
Find Inkplate documentation [here](https://soldered.com/documentation/inkplate/).
4042

41-
### Soldered Image Converter
42-
43-
In order to display an Image on Inkplate, you can use the Soldered Image Converter to convert from .png, .jpg, .bmp to .h files which can be easily added to your project. Download the latest release [here](https://github.com/SolderedElectronics/Soldered-Image-Converter/releases).
44-
45-
4643
### Battery power
4744

4845
Inkplate boards has two options for powering it. First one is obvious - USB port at side of the board. Just plug any micro USB cable and you are good to go. Second option is battery. Supported batteries are standard Li-Ion/Li-Poly batteries with 3.7V nominal voltage. Connector for the battery is standard 2.00mm pitch JST connector (except on Inkplate 2, it uses SMD solder pads for battery terminals). The onboard charger will charge the battery with 500mA when USB is plugged at the same time. You can use battery of any size or capacity if you don't have a enclosure. If you are using our enclosure, battery size shouldn't exceed 90mm x 40mm (3.5 x 1.57 inch) and 5mm (0.19 inch) in height (excluding Inkplate 2, it uses [this battery](https://soldered.com/product/li-ion-baterija-600mah-3-7v/). [This battery](https://soldered.com/product/li-ion-battery-1200mah-3-7v/) is good fit for the Inkplate. Also, Inkplate's hardware is specially optimized for low power consumption in deep sleep mode, making it extremely suitable for battery applications.
@@ -53,22 +50,6 @@ Please check the polarity on the battery JST connector! Some batteries that can
5350
#### ℹ NOTE
5451
CR2032 battery is only for RTC backup. Inkplate cannot be powered with it.
5552

56-
### Linux?
57-
58-
Running Linux? You'll need to run few other lines from your Terminal:
59-
60-
```
61-
apt install python3-pip
62-
pip3 install pyserial
63-
apt install python-is-python3
64-
```
65-
66-
In case you're getting an [error](https://github.com/SolderedElectronics/Inkplate-Arduino-library/issues/212) while trying to install pyserial, run the following command:
67-
68-
```
69-
apt install python3-serial
70-
```
71-
7253
### Open-source
7354

7455
All of Inkplate-related development is open-sourced:

0 commit comments

Comments
 (0)