Github CI enforcement that the Jupyter notebook is clean

.github/workflows/jupyter.yml

@@ -0,0 +1,17 @@
+---
+name: "Jupyter notebook"
+"on":
+  push:
+    paths:
+    - "**.ipynb"
+  pull_request:
+    paths:
+    - "**.ipynb"
+jobs:
+  lint-notebooks:
+    runs-on: "ubuntu-latest"
+    steps:
+    - name: "Check out code"
+      uses: "actions/checkout@v2"
+    - name: "Ensure Clean Jupyter Notebooks"
+      uses: "ResearchSoftwareActions/EnsureCleanNotebooksAction@1.1"

README.md

@@ -1,14 +1,16 @@
 # netcode-lag-simulator
 
-All of the code is [here](src/main/java/com/hopskipnfall).
+Open the Kotlin Jupyter notebook [Notebook.ipynb](Notebook.ipynb)
 
-To run the code, run:
+Before committing changes, make sure to clean the notebook outputs using the command 
 
-```sh
-./gradlew run
+```shell
+jupyter nbconvert --clear-output --inplace *.ipynb
 ```
 
-To format the code run:
+or by using the "clean" button in Intellij IDEA.
+
+When making changes to the code, use the formatter with:
 
 ```sh
 ./gradlew spotlessApply