Skip to content

Commit d8809ca

Browse files
committed
Add info about examples in Playground repo
7404e21 Add info from https://github.com/spdx/meetings/blob/main/asia/2024/2024-08-13.md Signed-off-by: Arthit Suriyawongkul <[email protected]>
1 parent f3ac01b commit d8809ca

File tree

1 file changed

+26
-22
lines changed

1 file changed

+26
-22
lines changed

README.md

Lines changed: 26 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -5,30 +5,34 @@ scenarios and use cases.
55

66
The repository is organized by profiles which represents a set of scenarios and
77
use cases for a particular domain (e.g. security, license compliance).
8-
Each directory contains a README.md file describing the profile and the
9-
examples contained within that directory.
10-
11-
The [`presentations`](./presentations/) directory contains examples included in
12-
various SPDX presentations.
13-
14-
Please note that this repository does not contain all of the supported fields
15-
nor all of the supported serialization formats in the latest version of the
16-
specification.
178

18-
Additional version-specific examples can be found in the `examples` directory
19-
of each specification version, for example:
9+
- [AI](./ai/)
10+
- [Dataset](./dataset/)
11+
- [Software](./software/)
2012

21-
- [v3.0.1](https://github.com/spdx/spdx-spec/tree/development/v3.0.1/examples)
22-
- [v2.3.1](https://github.com/spdx/spdx-spec/tree/development/v2.3.1/examples)
23-
24-
Moreover, in a page for each field in
25-
[SPDX Specification](https://spdx.github.io/spdx-spec/), there can also
26-
be a code snippet demonstrating how to use that particular field.
27-
28-
More guidance on using SPDX, including how to use SPDX License List short
29-
identifiers in source files and leverage SPDX for compliance with standards and
30-
regulations, is available in the [`spdx/using`](https://github.com/spdx/using/)
31-
repository.
13+
Each directory contains a README.md file describing the profile and the
14+
examples contained within that directory.
15+
Please note that they do not contain all supported fields or serialization
16+
formats specified in the latest version of the specification.
17+
18+
## More examples
19+
20+
- The [`presentations`](./presentations/) directory in this repository
21+
contains examples included in various SPDX presentations.
22+
- Moreover, in a page for each field in
23+
[SPDX Specification](https://spdx.github.io/spdx-spec/), there can also
24+
be a code snippet demonstrating how to use that particular field.
25+
- Additional version-specific examples can be found in the `examples` directory
26+
of each specification version in [`spdx-spec`](https://github.com/spdx/spdx-spec/) repository.
27+
For example:
28+
- [`v3.0.1`](https://github.com/spdx/spdx-spec/tree/development/v3.0.1/examples)
29+
- [`v2.3.1`](https://github.com/spdx/spdx-spec/tree/development/v2.3.1/examples)
30+
- More guidance on using SPDX, including how to use SPDX License List short
31+
identifiers in source files and leverage SPDX for compliance with standards
32+
and regulations, is available in the [`spdx/using`](https://github.com/spdx/using/)
33+
repository.
34+
- The Playground repository at [`spdx-3-serialization-prototype-playground`](https://github.com/spdx/spdx-3-serialization-prototype-playground)
35+
contains some examples that may not pass validation.
3236

3337
## Licenses
3438

0 commit comments

Comments
 (0)