Skip to content

Commit

Permalink
Add info about existing model output directory
Browse files Browse the repository at this point in the history
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
  • Loading branch information
bact committed Jun 10, 2024
1 parent 3c5d53f commit 3d96ae9
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,14 @@ directory. This directory contains two components:
- Formatted Makdown files: These files (`.md` extension) are located in various
subdirectories and are intended for processing by MkDocs in the next step.

If the output directory already exists, the `spec-parser` will not overwrite
it. If you edited a model file and want to regenerate the formatted files, you
have to delete the existing `spdx-spec/docs/model` directory first:

```shell
rm -rf spdx-spec/docs/model
```

### Building HTML

With all spec and model files prepared, we will use MkDocs to assemble them
Expand Down

0 comments on commit 3d96ae9

Please sign in to comment.