| Alexander Afanasyev | 7c97cfa | 2014-07-02 12:10:13 -0700 | [diff] [blame] | 1 | ChronoSync: synchronization library for distributed realtime applications for NDN |
| 2 | ================================================================================= |
| 3 | |
| Davide Pesavento | c2489b4 | 2017-10-28 17:19:08 -0400 | [diff] [blame] | 4 | [](https://travis-ci.org/named-data/ChronoSync) |
| 5 | |
| Nick Gordon | dc88507 | 2017-12-21 14:18:49 -0600 | [diff] [blame] | 6 | If you are new to the NDN community of software generally, read the |
| 7 | [Contributor's Guide](https://github.com/named-data/NFD/blob/master/CONTRIBUTING.md). |
| 8 | |
| Alexander Afanasyev | 7c97cfa | 2014-07-02 12:10:13 -0700 | [diff] [blame] | 9 | In supporting many distributed applications, such as group text messaging, file sharing, |
| 10 | and joint editing, a basic requirement is the efficient and robust synchronization of |
| 11 | knowledge about the dataset such as text messages, changes to the shared folder, or |
| Davide Pesavento | c2489b4 | 2017-10-28 17:19:08 -0400 | [diff] [blame] | 12 | document edits. This library implements the |
| 13 | [ChronoSync protocol](https://named-data.net/wp-content/uploads/2014/03/chronosync-icnp2013.pdf), |
| Alexander Afanasyev | 7c97cfa | 2014-07-02 12:10:13 -0700 | [diff] [blame] | 14 | which exploits the features of the Named Data Networking architecture to efficiently |
| 15 | synchronize the state of a dataset among a distributed group of users. Using appropriate |
| 16 | naming rules, ChronoSync summarizes the state of a dataset in a condensed cryptographic |
| 17 | digest form and exchange it among the distributed parties. Differences of the dataset can |
| 18 | be inferred from the digests and disseminated efficiently to all parties. With the |
| 19 | complete and up-to-date knowledge of the dataset changes, applications can decide whether |
| 20 | or when to fetch which pieces of the data. |
| 21 | |
| Alexander Afanasyev | 36eb3ed | 2017-01-11 12:35:58 -0800 | [diff] [blame] | 22 | ChronoSync uses [ndn-cxx](https://github.com/named-data/ndn-cxx) library as NDN development |
| 23 | library. |
| Alexander Afanasyev | 7c97cfa | 2014-07-02 12:10:13 -0700 | [diff] [blame] | 24 | |
| 25 | ChronoSync is an open source project licensed under GPL 3.0 (see `COPYING.md` for more |
| 26 | detail). We highly welcome all contributions to the ChronoSync code base, provided that |
| 27 | they can licensed under GPL 3.0+ or other compatible license. |
| 28 | |
| 29 | Feedback |
| 30 | -------- |
| 31 | |
| 32 | Please submit any bugs or issues to the **ChronoSync** issue tracker: |
| 33 | |
| Davide Pesavento | c2489b4 | 2017-10-28 17:19:08 -0400 | [diff] [blame] | 34 | * https://redmine.named-data.net/projects/chronosync |
| Alexander Afanasyev | 7c97cfa | 2014-07-02 12:10:13 -0700 | [diff] [blame] | 35 | |
| 36 | Installation instructions |
| 37 | ------------------------- |
| 38 | |
| 39 | ### Prerequisites |
| 40 | |
| 41 | Required: |
| 42 | |
| Davide Pesavento | c2489b4 | 2017-10-28 17:19:08 -0400 | [diff] [blame] | 43 | * [ndn-cxx and its dependencies](https://named-data.net/doc/ndn-cxx/) |
| Alexander Afanasyev | 7c97cfa | 2014-07-02 12:10:13 -0700 | [diff] [blame] | 44 | |
| 45 | ### Build |
| 46 | |
| 47 | To build ChronoSync from the source: |
| 48 | |
| 49 | ./waf configure |
| 50 | ./waf |
| 51 | sudo ./waf install |
| 52 | |
| Yingdi Yu | e042f83 | 2015-02-09 14:52:59 -0800 | [diff] [blame] | 53 | To build on memory constrained platform, please use `./waf -j1` instead of `./waf`. The |
| 54 | command will disable parallel compilation. |
| 55 | |
| Alexander Afanasyev | 7c97cfa | 2014-07-02 12:10:13 -0700 | [diff] [blame] | 56 | If configured with tests: `./waf configure --with-tests`), the above commands will also |
| 57 | generate unit tests in `./build/unit-tests` |