Skip to content

Commit

Permalink
Fixup readme text
Browse files Browse the repository at this point in the history
  • Loading branch information
jbygdell committed Nov 22, 2023
1 parent ead3b45 commit 8406c2d
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -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 \
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -42,21 +42,21 @@ $ make build-<folder-name>

#### 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
Expand All @@ -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-<folder-name>
Expand All @@ -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-<folder-name>
Expand Down

0 comments on commit 8406c2d

Please sign in to comment.