Skip to content

Commit 8118230

Browse files
authored
Update README.md
1 parent 6c83533 commit 8118230

1 file changed

Lines changed: 35 additions & 3 deletions

File tree

README.md

Lines changed: 35 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,20 @@
22

33
![](https://github.com/SolderedElectronics/Soldered-MicroPython-modules/blob/main/img/soldered_micropython.png)
44

5+
---
6+
57
## Overview
68
A collection of MicroPython drivers and modules for Soldered products. This library aims to provide plug-and-play support for sensors, displays, actuators, and other peripherals used with Soldered development boards.
79

10+
---
11+
812
## About
913
Soldered MicroPython Modules is an open-source library of MicroPython drivers developed and maintained by Soldered for our range of DIY electronics modules, sensors, and development boards. The goal is to make it easy for makers, educators, and engineers to get started quickly with Soldered hardware using MicroPython—whether for prototyping, classroom learning, or embedded projects.
1014

1115
Each module in the library is designed to be lightweight, readable, and compatible with a wide range of MicroPython-compatible microcontrollers.
1216

17+
---
18+
1319
## Installation
1420
You can install a specific module using mpremote or manually downloading specific files onto the board using an IDE such as [Thonny](https://thonny.org/)
1521

@@ -55,7 +61,29 @@ from bme280 import BME280
5561
],
5662
```
5763

58-
### About Soldered
64+
---
65+
66+
## Structure
67+
68+
Each Module has its own folder with its respective package.json for usage with the above mentioned **mpremote installation**. There is also the module itself as well as a folder with examples of using the modules
69+
The structure is as follows:
70+
71+
```
72+
Module_Name/
73+
|
74+
+--- package.json <-- Configuration file used by the mpremote package, contains dependencies and links to download module remotely
75+
|
76+
+--- Module_Name/
77+
| +--- Module_Name.py <-- The MicroPython module
78+
| |
79+
| `--- Examples/
80+
| |--- Module_Example.py <-- An example of how to use the respective module
81+
|
82+
```
83+
84+
---
85+
86+
## About Soldered
5987

6088
<img src="https://soldered.com/productdata/2023/01/soldered-logo-og.png" alt="soldered-logo" width="500"/>
6189

@@ -65,11 +93,15 @@ At Soldered, we design and manufacture a wide selection of electronic products t
6593
- [Tutorials & Projects](https://soldered.com/learn)
6694
- [Community & Technical support](https://soldered.com/community)
6795

68-
### Open-source license
96+
---
97+
98+
## Open-source license
6999

70100
Soldered invests vast amounts of time into hardware & software for these products, which are all open-source. Please support future development by buying one of our products.
71101

72-
This repository is under the MIT license. Long story short, use these open-source files for any purpose you want to, as long as you apply the same open-source licence to it and disclose the original source. No warranty - all designs in this repository are distributed in the hope that they will be useful, but without any warranty. They are provided "AS IS", therefore without warranty of any kind, either expressed or implied. The entire quality and performance of what you do with the contents of this repository are your responsibility. In no event, Soldered (TAVU) will be liable for your damages, losses, including any general, special, incidental or consequential damage arising out of the use or inability to use the contents of this repository.
102+
This repository is under the MIT license, for more info, see LICENSE. Long story short, use these open-source files for any purpose you want to, as long as you apply the same open-source licence to it and disclose the original source. No warranty - all designs in this repository are distributed in the hope that they will be useful, but without any warranty. They are provided "AS IS", therefore without warranty of any kind, either expressed or implied. The entire quality and performance of what you do with the contents of this repository are your responsibility. In no event, Soldered (TAVU) will be liable for your damages, losses, including any general, special, incidental or consequential damage arising out of the use or inability to use the contents of this repository.
103+
104+
---
73105

74106
## Have fun!
75107

0 commit comments

Comments
 (0)