-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
44 additions
and
1 deletion.
There are no files selected for viewing
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,45 @@ | ||
# malachite | ||
# Malachite | ||
|
||
[![Build Status][build-image]][build-link] | ||
[![Quint tests][quint-image]][quint-link] | ||
[![MBT tests][mbt-test-image]][mbt-test-link] | ||
[![Code coverage][coverage-image]][coverage-link] | ||
[![Apache 2.0 Licensed][license-image]][license-link] | ||
![Rust Stable][rustc-image] | ||
![Rust 1.74+][rustc-version] | ||
|
||
Tendermint consensus in Rust | ||
|
||
## Repository Overview | ||
|
||
The repository is split in three areas, each covering one of the important areas of this project: | ||
|
||
1. [Code](./Code): Comprises the Rust implementation of the Tendermint consensus algorithm, split across multiple Rust crates. | ||
2. [Docs](./Docs): Comprises Architectural Decision Records (ADRs) and other documentation, such as the 2018 paper describing the core consensus algorithm. | ||
3. [Specs](./Specs): English and [Quint][quint-repo] specifications. | ||
|
||
[quint-repo]: https://github.com/informalsystems/quint | ||
|
||
## License | ||
|
||
Copyright © 2023 Informal Systems Inc. | ||
|
||
Licensed under the Apache License, Version 2.0 (the "License"); you may not use the files in this repository except in compliance with the License. You may obtain a copy of the License at | ||
|
||
https://www.apache.org/licenses/LICENSE-2.0 | ||
|
||
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. | ||
|
||
|
||
[build-image]: https://github.com/informalsystems/malachite/actions/workflows/rust.yml/badge.svg | ||
[build-link]: https://github.com/informalsystems/malachite/actions/workflows/rust.yml | ||
[quint-image]: https://github.com/informalsystems/malachite/actions/workflows/quint.yml/badge.svg | ||
[quint-link]: https://github.com/informalsystems/malachite/actions/workflows/quint.yml | ||
[mbt-test-image]: https://github.com/informalsystems/malachite/actions/workflows/mbt.yml/badge.svg | ||
[mbt-test-link]: https://github.com/informalsystems/malachite/actions/workflows/mbt.yml | ||
[coverage-image]: https://codecov.io/gh/informalsystems/malachite/graph/badge.svg?token=B9KY7B6DJF | ||
[coverage-link]: https://codecov.io/gh/informalsystems/malachite | ||
[license-image]: https://img.shields.io/badge/license-Apache_2.0-blue.svg | ||
[license-link]: https://github.com/informalsystems/hermes/blob/master/LICENSE | ||
[rustc-image]: https://img.shields.io/badge/rustc-stable-orange.svg | ||
[rustc-version]: https://img.shields.io/badge/rustc-1.74+-orange.svg |