-
Notifications
You must be signed in to change notification settings - Fork 70
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
maintenance housekeeping: README, CONTRIBUTORS
- Loading branch information
Showing
6 changed files
with
41 additions
and
24 deletions.
There are no files selected for viewing
Empty file.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,4 @@ | ||
General maintainers:~ Archit Sharma (@arcolife) | ||
|
||
- dep | ||
- `hmake` command: Chen Xi (@hixichen) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,39 @@ | ||
# truechain-consensus-core | ||
TrueChain Consensus Protocol | ||
|
||
## Guide | ||
|
||
For pbft specific installation, checkout `pbft/` folder | ||
|
||
## Feedback | ||
|
||
Feedback is greatly appreciated. We're a blend of `py-go-c++` devs looking to merge ideas and we may err at times in the realm of language paradigms and correct design approach. We're hoping to find you (yes you!) and incentivize you for auditing our codebase, polish the erm out of it and teach us how to fish in this process. Feel free to open issues / contact us on our channels. | ||
|
||
## Contributing | ||
|
||
We need contributions from you. You are welcome to create github issues and contribute to the codebase. | ||
We have a list of important tasks from Truechain Foundation. We welcome people who have related background to join | ||
our consensus design and implementation. | ||
|
||
The maintainers actively manage the issues list, and try to highlight issues suitable for newcomers. | ||
The project follows the typical GitHub pull request model. | ||
See [CONTRIBUTIONS.md](CONTRIBUTIONS.md) for more details. | ||
Before starting any work, please either comment on an existing issue, or file a new one. | ||
|
||
## Community / Mailing lists | ||
|
||
Join our gitter channel for live discussions and clarifications. | ||
|
||
1. For contributions/general engineering discussions and all things PR/codebases [truechain-net/engg-foss-global](https://gitter.im/truechain-net/engg-foss-global) | ||
2. For events, announcements and so on [truechain-net/community](https://gitter.im/truechain-net/community) | ||
3. For research, [truechain-net/research](https://gitter.im/truechain-net/research) | ||
4. Architecture at [truechain-net/architecture](https://gitter.im/truechain-net/architecture) | ||
|
||
Subscribe to the [google groups mailing list](https://groups.google.com/forum/#!forum/truechain) to receive regular updates and post discussions | ||
|
||
|
||
## LICENSE | ||
|
||
The Apache License (2.0). | ||
|
||
A copy of the header is included within all files in the codebase along with the full [LICENSE](LICENSE) txt file in project's root folder. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters