diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..0d98490 --- /dev/null +++ b/LICENSE @@ -0,0 +1,7 @@ +Copyright 2022 imi415 + +Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..14bfd84 --- /dev/null +++ b/README.md @@ -0,0 +1,29 @@ +# Demo Projects for libusbsio + +## Introduction + +This repository contains demo projects which utilizes the `USBSIO` functionality +of the MCU-Link/MCU-Link Pro as well as some LPC-Link2 debug probes. + +The host library `libusbsio` is provided by NXP, modifications are made for use +with standard Linux environment. + +## How to build + +```bash +mkdir build && cd build +cmake .. +make +``` + +The binary files will be located at `build/demos/${DEMO_NAME}` + +## Demo List + +* i2cdetect: Similar to Linux `i2cdetect` utility, interrogates the I2C bus for devices. +* *Coming soon...* + +## Disclaimer + +The `License.txt` file contains NXP's original license terms, any other files not covered by the licenses above +shall subject to the MIT license, which attached in the `LICENSE` file. \ No newline at end of file