Added note about modularity of assignment

calaldees · Aug 29, 2023 · 3173bc3 · 3173bc3
1 parent 8dc427e
commit 3173bc3
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 2 deletions.
diff --git a/docs/assignment_digital_artifact.md b/docs/assignment_digital_artifact.md
@@ -87,6 +87,10 @@ Guidance
     * The system will be operating with less than 100 items (pagination is not needed)
 * You will be allocated marks for partial solutions (based on tests that pass)
 * You are working towards being a professional software engineers. It is expected that you share and discuss your solutions with peers throughout this assignment.
+* Modular assignment (use of reference/example implementations)
+    * The assignment has been split into server and client. You can gain marks for these independently. You do not need to complete a working server before you move on to the client or vice versa.
+    * If you are struggling with your server you could construct your client against the working reference server in `example_server`. See `Makefile` `run_your_client_with_example_server` and `test_your_client_with_example_server`. 
+    * You can also verify your server implementation against the reference client. See `Makefile` `run_example_client_with_your_server` and `test_example_client_with_your_server`
 
 ### Citations, Referencing and Acknowledging sources
 

diff --git a/example_client/README.md b/example_client/README.md
@@ -1,2 +1,5 @@
 Client Example
-==============
+==============
+
+* A reference implementation made without frameworks
+* Do not ever write production code like this
diff --git a/example_server/README.md b/example_server/README.md
@@ -1,2 +1,5 @@
 Server Example
-==============
+==============
+
+* A reference implementation made without frameworks
+* Do not ever write production code like this