Skip to content

Commit cb0be25

Browse files
readme for usage.
1 parent 5afc229 commit cb0be25

File tree

2 files changed

+18
-1
lines changed

2 files changed

+18
-1
lines changed

README.md

Lines changed: 17 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ This repository documents the Supplier API specification and provides an SDK wit
2222
- [Documentation](#documentation)
2323
- [Setup](#setup)
2424
- [Prerequisites and Configuration](#prerequisites-and-configuration)
25+
- [Build](#build)
2526
- [Licence](#licence)
2627

2728
## Documentation
@@ -33,7 +34,22 @@ This repository documents the Supplier API specification and provides an SDK wit
3334

3435
### Prerequisites and Configuration
3536

36-
Utilised the devcontainer, for pre reqs and configuration.
37+
- Utilised the devcontainer, for pre reqs and configuration.
38+
- You should open in a devcontainer or a Github workspaces.
39+
- By default it will run `make config` when the container is first setup
40+
- The [SDK](sdk) folder is excluded from all pre reqs
41+
- DO NOT make manual changes to the [SDK](sdk), instead [build](#build) it
42+
43+
## Build
44+
45+
To generate the SDK folder from changes to the [specification/api/notify-supplier.yml](specification/api/notify-supplier.yml) OAS specification:
46+
47+
```bash
48+
make clean
49+
make build
50+
```
51+
52+
Currently these are include in Git. TODO: gitignore these and have the build pipeline generate artifacts that can be downloaded from GitHub.
3753

3854
## Licence
3955

scripts/config/vale/styles/config/vocabularies/words/accept.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Podman
2222
pre
2323
Python
2424
rawContent
25+
SDK
2526
sed
2627
Syft
2728
Terraform

0 commit comments

Comments
 (0)