Skip to content

Commit 3cdf628

Browse files
committed
chg: dev: cleanup doc refs, replace DID contents, apply pre-comnmit
Signed-off-by: Stephen L Arnold <sarnold@vctlabs.com>
1 parent 85f3e7b commit 3cdf628

File tree

5 files changed

+508
-317
lines changed

5 files changed

+508
-317
lines changed

Makefile

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
default: docs
22

33
docs:
4-
$(MAKE) -C std
4+
$(MAKE) -C sdd
55

66
clean:
7-
$(MAKE) -C std clean
7+
$(MAKE) -C sdd clean

README.rst

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,16 @@
1111
What is this thing?
1212
===================
1313

14-
This is both a GitHub Template repository *and* a usable template for a
15-
DID-compliant Software Test Description in reStructuredText_. This repo contains
16-
the following items:
14+
This is both a GitHub Template repository *and* a usable doc template
15+
for a DID-compliant Software Test Description in reStructuredText_. The
16+
actual "template" comes in 2 parts, the actual DID content requirements
17+
outline and description, and the starter document with some example
18+
content based on the fictional ACME company's Engineering Unit Software
19+
Design Description.
1720

18-
* A Data Item Descripttion for a Software Test Description (SDD)
21+
This repo contains the following items:
22+
23+
* A Data Item Descripttion for a Software Design Description (SDD)
1924
in ASCII text format
2025
* A DID-compliant SDD outline using all the required DID sections (in
2126
reStructuredText format)
@@ -41,11 +46,11 @@ Contents after a fresh clone::
4146
├── pyproject.toml
4247
├── requirements-dia.txt
4348
├── resources # these are references or pre-inputs to the build workflow
44-
│   ├── SDD_DID_DI-IPSC-81439.txt # Software Test Description DID
49+
│   ├── SDD_DID_DI-IPSC-81435.txt # Software Design Description DID
4550
│   ├── example-title-page.rst # example title page source
4651
│   └── acme_webservice.py # source code for the example system diagram
47-
├── std
48-
│   ├── EU_SDD.rst # source code for the document/template
52+
├── sdd
53+
│   ├── EU_SDD.rst # source code for the starter document (template)
4954
│   ├── Makefile
5055
│   ├── images # graphics sources for document build
5156
│   │   ├── acme.png

0 commit comments

Comments
 (0)