From 23c114a000bd4b8b0be85760551cd1ff923ee3e7 Mon Sep 17 00:00:00 2001 From: Joseph Amalfitano <16958794+CanDoAnything@users.noreply.github.com> Date: Sun, 27 Oct 2019 22:24:00 -0400 Subject: [PATCH] minor readme tweaks; added empty/shell contributing and getting-started --- CONTRIBUTING.md | 8 ++++++++ GETTING-STARTED.md | 6 ++++++ README.md | 21 +++++++++------------ 3 files changed, 23 insertions(+), 12 deletions(-) create mode 100644 CONTRIBUTING.md create mode 100644 GETTING-STARTED.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 00000000..16a1e63b --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,8 @@ + +# Contributing + +{what are your rules for contributions?} + +{What branch should people do PRs to?} + +{I assume unit tests should be required for any new /changed code} diff --git a/GETTING-STARTED.md b/GETTING-STARTED.md new file mode 100644 index 00000000..dec4023b --- /dev/null +++ b/GETTING-STARTED.md @@ -0,0 +1,6 @@ + +# Getting Started + +## Basics + +{how do i get started using this? I see that Home assistant heavily relies on this library. I'd like to contribute} \ No newline at end of file diff --git a/README.md b/README.md index d197defa..854acd8e 100644 --- a/README.md +++ b/README.md @@ -19,17 +19,16 @@ This project is in early stages, so it is likely that APIs will change. Currently implemented features are: - * EZSP UART Gateway Protocol - * EZSP application protocol - * CLI wrapping basic ZigBee network operations (eg, scanning and forming a - network) - * ZDO functionality (with CLI) - * ZCL functionality (with CLI) - * An application framework with device state persistence +* EZSP UART Gateway Protocol +* EZSP application protocol +* CLI wrapping basic ZigBee network operations (eg, scanning and forming a network) +* ZDO functionality (with CLI) +* ZCL functionality (with CLI) +* An application framework with device state persistence An example use of the CLI: -``` +```bash $ export EZSP_DEVICE=/dev/ttyUSB1 $ bellows devices Device: @@ -52,7 +51,5 @@ $ bellows zcl 00:0d:6f:00:05:7d:2d:34 1 1026 read_attribute 0 ## Reference documentation - * EZSP UART Gateway Protocol Reference: - https://www.silabs.com/Support%20Documents/TechnicalDocs/UG101.pdf - * EZSP Reference Guide: - http://www.silabs.com/Support%20Documents/TechnicalDocs/UG100-EZSPReferenceGuide.pdf +* [EZSP UART Gateway Protocol Reference](https://www.silabs.com/Support%20Documents/TechnicalDocs/UG101.pdf) +* [EZSP Reference Guide](http://www.silabs.com/Support%20Documents/TechnicalDocs/UG100-EZSPReferenceGuide.pdf)