mirror of
https://github.com/gocsaf/csaf.git
synced 2025-12-22 05:40:11 +01:00
parent
03a907b9b8
commit
7fbc012e2c
2 changed files with 22 additions and 7 deletions
11
README.md
11
README.md
|
|
@ -59,13 +59,6 @@ Download the binaries from the most recent release assets on Github.
|
|||
|
||||
Binaries will be placed in directories named like `bin-linux-amd64/` and `bin-windows-amd64/`.
|
||||
|
||||
- Maintainers only: No need to do this if you have cloned this repository for unmodified usage only.
|
||||
```
|
||||
go generate ./...
|
||||
```
|
||||
will update the machine generated code.
|
||||
|
||||
|
||||
### Setup (Trusted Provider)
|
||||
|
||||
- [Install](https://nginx.org/en/docs/install.html) **nginx**
|
||||
|
|
@ -73,6 +66,10 @@ will update the machine generated code.
|
|||
- To configure nginx see [docs/provider-setup.md](docs/provider-setup.md)
|
||||
- To configure nginx for client certificate authentication see [docs/client-certificate-setup.md](docs/client-certificate-setup.md)
|
||||
|
||||
### Development
|
||||
|
||||
For further details of the development process consult our [development page](./docs/development.md).
|
||||
|
||||
|
||||
## License
|
||||
|
||||
|
|
|
|||
18
docs/Development.md
Normal file
18
docs/Development.md
Normal file
|
|
@ -0,0 +1,18 @@
|
|||
# Development
|
||||
|
||||
## Generated files
|
||||
|
||||
Some source code files are machine generated. At the moment these are only
|
||||
[cvss20enums.go](../csaf/cvss20enums.go) and [cvss3enums.go](../csaf/cvss3enums.go) on the
|
||||
basis of the [Advisory JSON schema](../csaf/schema/csaf_json_schema.json).
|
||||
|
||||
If you change the source files please regenerate the generated files
|
||||
with `go generate ./...` in the root folder and add the updated files
|
||||
to the version control.
|
||||
|
||||
If you plan to add further machine generated files ensure that they
|
||||
are marked with comments like
|
||||
```
|
||||
// THIS FILE IS MACHINE GENERATED. EDIT WITH CARE!
|
||||
```
|
||||
.
|
||||
Loading…
Add table
Add a link
Reference in a new issue