Skip to content

Commit cd82db2

Browse files
committed
chg: dev: update doc and project files, add minimal doorstop stub docs
* note readme needs an intro to doorstop and some normative items Signed-off-by: Stephen L Arnold <[email protected]>
1 parent f2cdc7b commit cd82db2

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

README.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,12 @@ with your own:
2020
* change the project name at the top of ``pyproject.toml``
2121
* change the project name in ``docs/source/conf.py`` *and* ``docs/source/index.rst``
2222
* change the author and copyright names in all the doorstop doc and config files, ie
23+
2324
+ ``find . -name .doorstop.yml`` and review/edit all files
2425

26+
+ then replace all the doorstop content with your own project details
27+
+ create more doorstop items as needed, link specific design and test
28+
elements back to related **Shall** statements
2529
* change the author details in ``pyproject.toml`` *and* ``docs/source/conf.py``
2630
* change the package directory name under the ``src`` folder
2731
* change the github URL paths in ``pyproject.toml``

docs/swd/SDD001.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,6 @@ figure below:
3636
Simple Software Units (captured from mermaid to SVG or PNG).
3737
```
3838

39-
4039
<details>
4140
<summary>simple_dependency_graph source</summary>
4241
simple dependency graph showing primary software units.
@@ -58,4 +57,4 @@ Simple Software Units (captured from mermaid to SVG or PNG).
5857

5958
## Design decisions
6059

61-
More text here.
60+
More text here.

0 commit comments

Comments
 (0)