Update README, add contribution guidelines

Author: alex-mous

CMakeLists.txt

@@ -16,7 +16,6 @@ project(VL53L1X_api
         VERSION 1.0.1
         DESCRIPTION "VL53L1X Raspberry Pi Pico/Pico W API")
 
-
 set(CMAKE_C_STANDARD 11)
 set(CMAKE_CXX_STANDARD 17)
 
@@ -32,29 +31,6 @@ add_compile_options(-Wall
         -Wno-maybe-uninitialized
         )
 
-add_subdirectory(VL53L1X_pico)
-
-add_subdirectory(examples)
-
-
-#include(GNUInstallDirs)
-
-#add_library(${PROJECT_NAME} SHARED
-#    src/VL53L1X_api.c
-##    src/VL53L1X_calibration.c
- #   src/VL53L1_platform.c
-#    )
-
-#set_target_properties(${PROJECT_NAME} PROPERTIES VERSION ${PROJECT_VERSION})
-
-#configure_file(${PROJECT_NAME}.pc.in ${PROJECT_NAME}.pc @ONLY)
-
-#target_include_directories(${PROJECT_NAME} PRIVATE .)
-
-#target_link_libraries(${PROJECT_NAME} pico_stdlib)
-
-#install(TARGETS VL53L1X_api
-#    LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
-#    PUBLIC_HEADER DESTINATION ${CMAKE_INSTALL_INCLUDEDIR})
+add_subdirectory(VL53L1X_pico_api)
 
-#install(FILES ${CMAKE_BINARY_DIR}/VL53L1X_api.pc DESTINATION ${CMAKE_INSTALL_DATAROOTDIR}/pkgconfig)
+add_subdirectory(examples)

CONTRIBUTING.md

@@ -0,0 +1,39 @@
+# Contributions
+Thanks for your interest in contributing to this project. The contribution process involves several different scopes listed below.
+- Reporting bugs
+- Discussing the codebase
+- Submitting bug fixes
+- Proposing new features
+- Submitting new features
+- Becoming a maintainer
+
+## Code Changes Happen With Pull Requests
+Please see the [Github Flow](https://guides.github.com/introduction/flow/index.html).
+
+Pull requests are the best way to propose changes to the codebase. To contribute a pull request:
+
+1. Fork the repository and create your branch from `main`.
+2. If you've added code, please consider adding tests.
+3. If you've modified existing code, please state the reason and update the documentation.
+4. Match the existing code style (roughly Google C++ Style Guide).
+5. Submit the pull request with the details of your feature/fix!
+
+## Please report bugs using Github Issues
+This is the easiest way to track bugs and discuss fixes (e.g. if the code needs a patch, or if there's an issue with documentation, etc.). Report bugs by [opening an issue](https://github.com/briandk/transcriptase-atom/issues).
+
+## Remember to write bug reports with detail, background, and an example of the issue
+Please provide enough information so that the error could be reproduced!
+
+Ideally, the report should have:
+- Summary/background of the bug
+- Detailed information on your setup steps
+    - Information to reproduce the bug
+- Expected output, and actual output
+- Any information about what you think might be going wrong
+
+
+## Code Style
+As above, please follow the Google C++ Style Guide when submitting changes.
+
+## License
+By contributing, you acknowledge and agree that your contributions will be licensed under its MIT License.

README.md

@@ -1,19 +1,45 @@
 # VL53L1X-C-API-Pico
-VL53L1X Time-of-Flight distance sensor API for the Raspberry Pi Pico/Pico W
+![GitHub release (latest SemVer)](https://img.shields.io/github/v/release/alex-mous/VL53L1X-C-API-Pico)
+![GitHub](https://img.shields.io/github/license/alex-mous/VL53L1X-C-API-Pico)
+![GitHub issues](https://img.shields.io/github/issues/alex-mous/VL53L1X-C-API-Pico)
+![GitHub contributors](https://img.shields.io/github/contributors/alex-mous/VL53L1X-C-API-Pico)
+## Description
 
-### Some features of this API are still in progress, but basic measurements work.
+A light, easy-to-use VL53L1X Time-of-Flight distance sensor driver/API in C/C++ for the Raspberry Pi Pico/Pico W. This project implements and extends the STMicroelectronics template driver for this sensor, specifically for Rasbperry Pi Pico/Pico W microcontrollers.
 
-## Usage
-See the examples for usage. To build the project, run the following:
+## Contributing
+Please see [CONTRIBUTING.md](CONTRIBUTING.md)
+
+## Future Features
+- C++ object-oriented library
+- Easy way to configure defaults passed into initialization functions
+
+
+# Usage
+To use this library in your own project, include the `VL53L1X_pico_api` directory in your CMake script (e.g. `add_subdirectory(VL53L1X_pico_api)`). Then, include the needed headers as specified below, and add `VL53L1X_pico_api` to the `target_link_libraries` for your project. Running `cmake` for your project should then include and compile this API as needed.
+
+# Examples
+To build the project, first clone the code and then run the following:
 ```
 mkdir build
 cd build
 cmake ..
 make
 ```
-If you have a Pico W, append `-DPICO_BOARD=pico_w` to the `cmake` command.
+Note: if you have a Pico W, append `-DPICO_BOARD=pico_w` to the `cmake` command.
+
+This will build the example code. The resulting uf2 file in the `build/examples/continuous_measurement` can be uploaded to a Pico/Pico W. This example shows how to initialize and use the VL53L1X sensor to continously measure. 
+
+# Documentation
+The header files all have extensive documentation on the purpose of each function, which can be supplemented by the *STMicroelectronics VL53L1X Ultra Lite Driver User Manual (UM2510)*.
+
+The three header files that can be included to use API functions are:
+    - `VL53L1X_types.h`: This header file store types used in the API (status and results definitions, etc.).
+    - `VL53L1X_api.h`: This header file contains all of the main API functions (initialization functions, getters and setters for registers, and functions to start/stop/read ranging).
+    - `VL53L1X_calibration.h`: This header file contains functions to calibrate the VL53L1X sensor.
+In addition, the final header file, `VL53L1X_platform.h`, contains platform-specific functions and definitions (e.g. I2C setup and read/write for the Pico and Pico W). 
 
-The resulting uf2 files to upload to the Pico board reside in the build/examples directory.
+For most use cases, just including the first two header files should be sufficient.
 
-## License
-This API uses the `core` code from STMicroelectronics, and implements the platform for Raspberry Pi Pico/Pico W. The implemntation, under `platform`, is licensed under the MIT License. Code provided by STMicroelectronics (in `core`) is provided under the BSD 3-clause "New" or "Revised" License.
+# License
+This API extends, rewrites, and implements the VL53L1X driver code from STMicroelectronics. Code provided by STMicroelectronics (in `core`) is provided under the BSD 3-clause "New" or "Revised" License. All changes are licensed under the MIT License.

VL53L1X_pico/CMakeLists.txt renamed to VL53L1X_pico_api/CMakeLists.txt

@@ -1,8 +1,8 @@
-add_library(VL53L1X_api VL53L1X_platform.c VL53L1X_api.c)
+add_library(VL53L1X_pico_api VL53L1X_platform.c VL53L1X_api.c)
 add_library(VL53L1X_calibration VL53L1X_calibration.c VL53L1X_platform.c VL53L1X_api.c)
 
-target_include_directories(VL53L1X_api INTERFACE ${CMAKE_CURRENT_SOURCE_DIR})
+target_include_directories(VL53L1X_pico_api INTERFACE ${CMAKE_CURRENT_SOURCE_DIR})
 target_include_directories(VL53L1X_calibration INTERFACE ${CMAKE_CURRENT_SOURCE_DIR})
 
-target_link_libraries(VL53L1X_api pico_stdlib hardware_i2c)
+target_link_libraries(VL53L1X_pico_api pico_stdlib hardware_i2c)
 target_link_libraries(VL53L1X_calibration pico_stdlib hardware_i2c)