Skip to content

minor readme tweaks; added empty/shell contributing and getting-started #192

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
CanDoAnything wants to merge 1 commit into from
Closed

minor readme tweaks; added empty/shell contributing and getting-started #192

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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}
6 changes: 6 additions & 0 deletions GETTING-STARTED.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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}
21 changes: 9 additions & 12 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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)