From 904fcc785fd1b74ecca9e2a561e76e09c3038a32 Mon Sep 17 00:00:00 2001 From: Erick Lavoie <erick.lavoie@unibas.ch> Date: Tue, 26 Sep 2023 19:09:06 +0000 Subject: [PATCH] Update README.md --- README.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 551786f..4959ec6 100644 --- a/README.md +++ b/README.md @@ -34,13 +34,18 @@ command is accessible from `crb/COMMAND`. ## Implementation Tutorial -Suggested order: +To make your life easier, we suggest you implement the API commands from lower level to higher level in the following order: 1. [`author-append`](#1-implement-author-append-see-api) 2. [`repo-push`](#2-implement-crbrepo-push-see-api) 3. [`repo-fetch`](#3-implement-crbrepo-fetch-see-api) 4. [`repo-merge`](#4-implement-crbrepo-merge-see-api) 5. [`repo-deliver`](#5-implement-crbrepo-deliver-see-api) +Once you have implemented and tested them using the instructions below, it should be easy to implement `crb/broadcast` and `crb/deliver`. You will then be ready to test the [Causal Broadcast Scenario](#causal-broadcast-scenario). + +*The following commands assume that the `causal-broadcast` directory is within +your `PATH` environment variable, following the installation instructions so that all commands under `causal-broadcast/crb` can be accessed with `crb/COMMAND`.* + ### 1. Implement `author-append` (see [API](#crbauthor-append-author-msg-src)) Relevant commands are provided in the slides for 'Commit' and 'Reference'. @@ -300,9 +305,6 @@ In this section we provide an interaction scenario between three processes that illustrates both the behaviour of the implementation as well as the properties of the abstraction it implements. -*The following commands assume that the `causal-broadcast` directory is within -your `PATH` environment variable, following the installation instructions so that all commands under `causal-broadcast/crb` can be accessed with `crb/COMMAND`.* - ### Initialization Create three processes, one for each author `alice`, `bob`, and `carol`: -- GitLab