Skip to content

Commit 7b18eaa

Browse files
committed
update README with commands to build the documentation
1 parent ad30777 commit 7b18eaa

File tree

1 file changed

+35
-1
lines changed

1 file changed

+35
-1
lines changed

README.md

Lines changed: 35 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,36 @@
11
# process_description
2-
Score project process description
2+
S-CORE process description
3+
4+
## Overview
5+
The S-CORE process model aims to establish organization rules for developing open source software in the automotive industry, which can be used in safety and security context.
6+
7+
8+
## Features
9+
10+
The process model provide processes, which conform to state-of the art standards
11+
- ASPICE PAM 4.0
12+
- ISO 26262
13+
- ISO/SAE 21434
14+
- ISO PAS 8926
15+
16+
## Building process documentation
17+
18+
#### Run a documentation build:
19+
20+
```bash
21+
bazel run //process:incremental
22+
bazel build //process:docs
23+
bazel run //process:ide_support
24+
```
25+
26+
#### Access your documentation at:
27+
28+
- `_build/` for incremental
29+
- `bazel-bin/bazel-bin/<BUILD FILE FOLDER NAME>/docs/_build/html`
30+
31+
#### Format your documentation with:
32+
33+
```bash
34+
bazel test //:format.test
35+
bazel run //:format.fix
36+
```

0 commit comments

Comments
 (0)