Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve readmes #43

Merged
merged 1 commit into from
Nov 23, 2023
Merged

Improve readmes #43

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 15 additions & 11 deletions bash/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,21 @@

[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:

```
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
Expand Down Expand Up @@ -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`
Expand All @@ -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
Expand All @@ -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`
12 changes: 6 additions & 6 deletions dotnet/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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`