Skip to content

Commit

Permalink
Add code of conduct and contributor guide
Browse files Browse the repository at this point in the history
  • Loading branch information
glopesdev committed Jul 31, 2023
1 parent a2af1d1 commit d43e8d9
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
5 changes: 5 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Code of Conduct

This project has adopted the Contributor Covenant code of conduct to clarify expected behavior in our community.

For more information, see the [Bonsai Foundation Code of Conduct](https://bonsai-rx.org/code-of-conduct).
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,15 @@
# Bonsai - Harp Library

Bonsai Library containing interfaces for data acquisition and control of devices implementing the Harp protocol.
Bonsai.Harp is the [Bonsai](https://bonsai-rx.org/) reference implementation of the [Harp](https://harp-tech.org/) protocol. It also provides shared core functionality for the high-level device interfaces in the [Harp ecosystem](https://github.com/harp-tech).

The Harp ecosystem allows extending experimental setup hardware functionality with integrated timestamp synchronisation across devices.

## How to install

Bonsai.Harp can be installed directly through the Bonsai package manager. In order to get editor and firmware update support, you should download both the `Bonsai.Harp` and `Bonsai.Harp.Design` packages.

## Contributing

Bonsai is a programming language with a growing community of users and developers. Anyone is welcome to participate by reporting bugs, proposing features or improvements, or contributing pull requests directly to our open-source repositories.

For more information please see our [Contributor Guide](https://bonsai-rx.org/contribute/). By contributing to this project, we also expect you to uphold our community [Code of Conduct](https://bonsai-rx.org/code-of-conduct).

0 comments on commit d43e8d9

Please sign in to comment.