Skip to content
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.

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

docs: update the readme of repo #16

Merged
merged 8 commits into from
Jun 24, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Chronos organization layout is as follows:
* [`crates/`](./crates/) the common dependences and core functional crates folder.
* [`demos/`](./demos/) some use cases of applied the Chronos and proposals.
* [`docs/`](./docs/) design and applied documents for demonstrating thoughts.
* `src/` the source codebase of shared definitions and some common codes.
* [`src/`](./src/) the source codebase of shared definitions and some common codes.

## Features

Expand All @@ -34,11 +34,11 @@ Please refer to [hetu key research](https://github.com/hetu-project#hetu-key-res
Regular logical clock have been applied in many scenarios. As follows:

- Weakly consistent storage systems
- `Cops: causally Consistent Data Store`
- Causally ordered broadcast
- [Reference: vlc + p2p combined](https://github.com/NagaraTech/hetu-docs/blob/main/Zeb/vlc.md)
- [Cops: Causal Consistency Data Storage](https://www.cs.cmu.edu/~dga/papers/cops-sosp2011.pdf)
- Broadcast events with causally ordered
- [Reference: verifiable clock & p2p combined or optimizing](https://github.com/hetu-project/docs/blob/main/Zeb/vlc.md)
- Deadlock detection
- `Mutual exclusion` of shared resources in a distributed system
- Mutual exclusion of shared resources in a distributed system
- Bakery algorithm
- Distributed snapshots
- Distributed system debugging.
Expand Down
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,6 @@
This document warehouse mainly consist of following parts:

## Applied specification
- [vlc and application brief description](./applied/vlc%20and%20application%20brief%20description.md)
- [VLC and Application Brief Description](./applied/vlc%20and%20application%20brief%20description.md)
## Design Documents
- [Concurrent Stateful Apps with Sessions](./design/Concurrent%20Stateful%20Apps%20with%20Sessions.md)libraries
- [Concurrent Stateful Apps with Sessions](./design/Concurrent%20Stateful%20Apps%20with%20Sessions.md)
4 changes: 4 additions & 0 deletions src/lib.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/*
* Please refer to `crates` for core functional toolbox for now.
* Some shared definitions and common codes will follow.
*/
Loading