From d05591559e62a976256654dafa1c5a848631b4ff Mon Sep 17 00:00:00 2001 From: ardnew Date: Mon, 11 Sep 2023 13:05:54 -0500 Subject: [PATCH] Update README.md --- README.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/README.md b/README.md index 47c6660..1ca8c9f 100644 --- a/README.md +++ b/README.md @@ -19,4 +19,21 @@ The default C++ API at the bottom of the table is used for all other platforms. |ESP-IDF|`esp_timer.h`|`int64_t esp_timer_get_time(void)`|`int64_t`|Microseconds| |C++|`std::chrono`|`std::chrono::steady_clock`|`int64_t`|Microseconds[^1]| +#### Integration +###### Manual**_A_** +Fetch repository, add `#include ` to your sources, and modify your compiler's includes — with a [Makefile, for example](examples/exec-duration/Makefile): + +```Makefile +CFLAGS += -I/foo/cronos/src -g -Wall +CXXFLAGS += $(CFLAGS) -std=gnu++17 +``` +###### Manual**_B_** +Fetch repository, copy [`src/cronos.h`](src/cronos.h) into your project, add `#include "cronos.h"` to your sources. + +###### Arduino +This [library](library.properties) conforms to the [Arduino Library Specification (1.5)](https://arduino.github.io/arduino-cli/0.34/library-specification/). Install using the Library Manager via [IDE](https://github.com/arduino/arduino-ide) (or [GUI](https://github.com/arduino/Arduino)) or with command `arduino-cli lib install cronos` using the [CLI](https://github.com/arduino/arduino-cli). + +###### ESP-IDF **_TODO_** +- [ ] _Add support files required to implement an ESP-IDF library/component_. + [^1]: Actual resolution may be less. The LSBs of the 64-bit system tick count will be padded with `0` if the system does not support microsecond resolution.