Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
n-elia authored Mar 26, 2022
1 parent 98a6e24 commit b91709f
Showing 1 changed file with 12 additions and 3 deletions.
15 changes: 12 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,14 +58,23 @@ To run the example in `./example` folder, please set your WiFi credentials in `b

### Including this library into your project (**manual way**)

To directly include the library into a MicroPython project, it's sufficient to copy `max30102/circular_buffer.py` and `max30102/max30102.py` next to your `main.py` file, into a `lib` directory. Then, import the constructor as follows:
To directly include the library into a MicroPython project, it's sufficient to copy `max30102/circular_buffer.py` and `max30102/max30102.py` next to your `main.py` file, or into a `lib` directory. Then, import the constructor as follows:

```python
from max30102 import MAX30102
```

To run the example in `./example` folder, copy `max30102/circular_buffer.py` and `max30102/max30102.py` into the `./example/lib` directory. Then, upload the `./example` directory content into your microcontroller. After the upload, press the reset button of your board are you're good to go.

To run the example in `./example` folder, copy `max30102/circular_buffer.py` and `max30102/max30102.py` into the `./example/lib` directory. Then, upload the `./example` directory content into your microcontroller.
The content of the board root should appear as follows:
```
/
└── root.py
└── main.py
└── lib
└── circular_buffer.py
└── max30102.py
```
After the upload, press the reset button of your board are you're good to go.

### Setup and configuration
#### I2C pins
Expand Down

0 comments on commit b91709f

Please sign in to comment.