diff --git a/README.md b/README.md index 0f90cf7..7fd4fc0 100644 --- a/README.md +++ b/README.md @@ -8,19 +8,18 @@ SHT product line. ``` ## Repository content -* embedded-common (submodule repository for common embedded driver stuff) -* sht-common (SHTxx related) +* embedded-common (submodule repository for the common embedded driver HAL) +* sht-common (common files for all SHTxx drivers) * sht3x (SHT3x driver related) -* shtc1 (SHTC1/SHTW1/SHTW2 driver related) +* shtc1 (SHTC3/SHTC1/SHTW1/SHTW2 driver related) ## Collecting resources ``` make release ``` -This will create a release folder -with the necessary driver files in it, including a Makefile. That way, you have -just ONE folder with all the sources ready to build your driver for your -platform. +This will create the `release` folder with the necessary driver files in it, +including a Makefile. That way, you have just ONE folder with all the sources +ready to build your driver for your platform. ## Files to adjust (from embedded-common) You only need to touch the following files: @@ -28,17 +27,18 @@ You only need to touch the following files: * `sensirion_arch_config.h` (architecture specifics, you need to specify the integer sizes) -and depending on your i2c implementation one of the following: +and depending on your i2c implementation either of the following: -* `sensirion_hw_i2c_implementation.c` (functions for hardware i2c -communication if your platform supports that) -* `sensirion_sw_i2c_implementation.c` (functions for software i2c -communication via GPIOs) +* `embedded-common/hw_i2c/sensirion_hw_i2c_implementation.c` + functions for hardware i2c communication if your platform supports that +* `embedded-common/sw_i2c/sensirion_sw_i2c_implementation.c` + functions for software i2c communication via GPIOs ## Building the driver 1. Adjust sensirion\_arch\_config.h if you don't have the `` header file available 2. Implement necessary functions in one of the `*_implementation.c` files + described above 3. make ---