Skip to content

Commit 2c1ede5

Browse files
committed
docs: update readme doc
1 parent 01f7aa8 commit 2c1ede5

File tree

3 files changed

+10
-6
lines changed

3 files changed

+10
-6
lines changed

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ Chronos organization layout is as follows:
1313
* [`crates/`](./crates/) the common dependences and core functional crates folder.
1414
* [`demos/`](./demos/) some use cases of applied the Chronos and proposals.
1515
* [`docs/`](./docs/) design and applied documents for demonstrating thoughts.
16-
* `src/` the source codebase of shared definitions and some common codes.
16+
* [`src/`](./src/) the source codebase of shared definitions and some common codes.
1717

1818
## Features
1919

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

3636
- Weakly consistent storage systems
37-
- `Cops: causally Consistent Data Store`
38-
- Causally ordered broadcast
39-
- [Reference: vlc + p2p combined](https://github.com/NagaraTech/hetu-docs/blob/main/Zeb/vlc.md)
37+
- [Cops: Causal Consistency Data Storage](https://www.cs.cmu.edu/~dga/papers/cops-sosp2011.pdf)
38+
- Broadcast events with causally ordered
39+
- [Reference: verifiable clock & p2p combined or optimizing](https://github.com/hetu-project/docs/blob/main/Zeb/vlc.md)
4040
- Deadlock detection
41-
- `Mutual exclusion` of shared resources in a distributed system
41+
- Mutual exclusion of shared resources in a distributed system
4242
- Bakery algorithm
4343
- Distributed snapshots
4444
- Distributed system debugging.

docs/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,4 +5,4 @@ This document warehouse mainly consist of following parts:
55
## Applied specification
66
- [vlc and application brief description](./applied/vlc%20and%20application%20brief%20description.md)
77
## Design Documents
8-
- [Concurrent Stateful Apps with Sessions](./design/Concurrent%20Stateful%20Apps%20with%20Sessions.md)libraries
8+
- [Concurrent Stateful Apps with Sessions](./design/Concurrent%20Stateful%20Apps%20with%20Sessions.md)

src/lib.rs

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
/*
2+
* Please refer to `crates` for core functional toolbox for now.
3+
* Some shared definitions and common codes will follow.
4+
*/

0 commit comments

Comments
 (0)