Update README and workflow names. Add config draft

Signed-off-by: guillemdb <[email protected]>

.github/workflows/build.yml

@@ -81,13 +81,13 @@ jobs:
           rye pin --relaxed cpython@${{ matrix.python-version }}
           rye sync --all-features
 
-      - name: Run Pytest on MacOS
+      - name: Run Pytest on MacOS with rye
         if: ${{ matrix.os == 'macos-latest' }}
         run: |
           set -x
           rye run test
 
-      - name: Run code coverage on Ubuntu
+      - name: Run code coverage on Ubuntu with rye
         if: ${{ matrix.os == 'ubuntu-latest' }}
         run: |
           set -x

README.md

@@ -5,6 +5,20 @@ Automate project creation following ML best practices.
 
 * License: MIT license
 
+## Setting up the repository
+
+1. Clone the repository:
+2. Initialize the submodules:
+```bash
+git submodule update --init --recursive
+```
+
+# Testing the templates
+1. Navigate to the project root directory.
+2. run cookiecutter with the template directory:
+```bash
+cookiecutter templates/mlops --no-input --overwrite-if-exists
+```
 
 ## Features