From 8406c2dd50c5635d608a90d61eeb336739f114d7 Mon Sep 17 00:00:00 2001 From: Joakim Bygdell Date: Wed, 22 Nov 2023 06:42:22 +0100 Subject: [PATCH] Fixup readme text --- Makefile | 2 +- README.md | 12 ++++++------ 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/Makefile b/Makefile index 772686527..aa655ce22 100644 --- a/Makefile +++ b/Makefile @@ -6,7 +6,7 @@ help: @echo 'Welcome!' @echo '' @echo 'This Makefile is designed to make the development work go smoothly.' - @echo 'Indepth description of how to use this Makefile can be fould in the README.md' + @echo 'In-depth description of how to use this Makefile can be found in the README.md' bootstrap: go-version-check @for dir in sda sda-auth sda-download; do \ diff --git a/README.md b/README.md index 31b2f4ffb..8f1d51937 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ $ make bootstrap ### Makefile options -The Makefile is primarily designd to be an aid during development work. +The Makefile is primarily designed to be an aid during development work. #### Building the containers @@ -42,21 +42,21 @@ $ make build- #### Running the integration tests -This will build the container and run the integration test for the postgresql container. The same test will run on every PR in github: +This will build the container and run the integration test for the PostgreSQL container. The same test will run on every PR in github: ```sh $ make integrationtest-postgres ... ``` -This will build the rabbitmq and sda containers and run the integration test for the rabbitmq container. The same test will run on every PR in github: +This will build the RabbitMQ and SDA containers and run the integration test for the RabbitMQ container. The same test will run on every PR in github: ```sh $ make integrationtest-rabbitmq ... ``` -This will build all containers and run the integration tests for the sda stack. The same test will run on every PR in github: +This will build all containers and run the integration tests for the SDA stack. The same test will run on every PR in github: ```sh $ make integrationtest-sda @@ -72,7 +72,7 @@ $ make lint-all ... ``` -To run golangci-lint for a speciffic component replace `all` with the folder name (sda, sda-auth, sda-download): +To run golangci-lint for a speciffic component replace `all` with the folder name (`sda`, `sda-auth`, `sda-download`): ```sh $ make lint- @@ -90,7 +90,7 @@ $ make test-all ... ``` -To run the static code tests for a speciffic component replace `all` with the folder name (sda, sda-auth, sda-download, sda-sftp-inbox): +To run the static code tests for a speciffic component replace `all` with the folder name (`sda`, `sda-auth`, `sda-download`, `sda-sftp-inbox`): ```sh $ make test-