From 7e13f8c07929e52f17c8db48d501019a960b3c5e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Roger=20Vi=C3=B1as?= <roger.vinas@fastzink.com>
Date: Thu, 23 Nov 2023 09:44:52 +0100
Subject: [PATCH] Improve readmes

---
 bash/README.md   | 26 +++++++++++++++-----------
 dotnet/README.md | 12 ++++++------
 2 files changed, 21 insertions(+), 17 deletions(-)

diff --git a/bash/README.md b/bash/README.md
index c9a91fd..9108b8a 100644
--- a/bash/README.md
+++ b/bash/README.md
@@ -5,6 +5,14 @@
 
 [Bash](https://www.gnu.org/software/bash/) testing with [BATS](https://bats-core.readthedocs.io/en/stable/#)
 
+- [Show me the code](#show-me-the-code)
+  - [Implementation](#implementation)
+  - [Test](#test)
+- [Run this project using 🐳 docker](#run-this-project-using--docker)
+- [Run this project locally](#run-this-project-locally)
+
+## BATS git submodules
+
 ⚠️ This project includes **BATS** git submodules so once you clone the repo you will need to init and update them:
 
 ```
@@ -12,12 +20,6 @@ git submodule init
 git submodule update
 ```
 
-- [Show me the code](#show-me-the-code)
-  - [Implementation](#implementation)
-  - [Test](#test)
-- [Run this project using 🐳 docker](#run-this-project-using--docker)
-- [Run this project locally](#run-this-project-locally)
-
 ## Show me the code
 
 ### Implementation
@@ -143,6 +145,7 @@ Take a look at the other [Libraries and Add-ons](https://bats-core.readthedocs.i
 
 ## Run this project using 🐳 [docker](https://www.docker.com/)
 
+- Ensure you have updated [BATS git submodules](#bats-git-submodules)
 - Execute `./docker-run.sh`
 - Once inside the container:
   - Test with `./test/bats/bin/bats test/hello.bats`
@@ -154,6 +157,12 @@ Take a look at the other [Libraries and Add-ons](https://bats-core.readthedocs.i
 
 - Ensure you have **bash** installed `bash --version` (this project uses version 5.2)
 
+### Run locally
+
+- Ensure you have updated [BATS git submodules](#bats-git-submodules)
+- Test with `./test/bats/bin/bats test/hello.bats`
+- Run with `./src/hello.bash`
+
 ### Create project from scratch
 
 - Create an empty project with `src` and `test` folders
@@ -164,8 +173,3 @@ git submodule add https://github.com/bats-core/bats-core.git test/bats
 git submodule add https://github.com/bats-core/bats-support.git test/test_helper/bats-support
 git submodule add https://github.com/bats-core/bats-assert.git test/test_helper/bats-assert
 ```
-
-### Run locally
-
-- Test with `./test/bats/bin/bats test/hello.bats`
-- Run with `./src/hello.bash`
diff --git a/dotnet/README.md b/dotnet/README.md
index 2e857fd..52092e8 100644
--- a/dotnet/README.md
+++ b/dotnet/README.md
@@ -156,6 +156,12 @@ Total tests: 2
 - Install [.NET](https://dotnet.microsoft.com/download)
   - Check [.NET CLI](https://learn.microsoft.com/dotnet/core/tools/) executing `dotnet --version`
 
+### Run locally
+
+- Test with `dotnet test -v quiet -l:"console;verbosity=normal"`
+- Run with `dotnet run --project Hello.Main`
+- Build with `dotnet publish -c Release`
+
 ### Create project from scratch
 
 - Execute these commands:
@@ -171,9 +177,3 @@ dotnet add ./Hello.Test package Moq --version 4.20.69
 
 dotnet sln Hello.sln add ./Hello.Main ./Hello.Test
 ```
-
-### Run locally
-
-- Test with `dotnet test -v quiet -l:"console;verbosity=normal"`
-- Run with `dotnet run --project Hello.Main`
-- Build with `dotnet publish -c Release`