File tree Expand file tree Collapse file tree 2 files changed +31
-10
lines changed Expand file tree Collapse file tree 2 files changed +31
-10
lines changed Original file line number Diff line number Diff line change 2
2
3
3
![ ] ( https://github.com/stanislaw/strictdoc/workflows/StrictDoc%20on%20macOS/badge.svg )
4
4
![ ] ( https://github.com/stanislaw/strictdoc/workflows/StrictDoc%20on%20Linux/badge.svg )
5
+ ![ ] ( https://github.com/stanislaw/strictdoc/workflows/StrictDoc%20on%20Windows/badge.svg )
5
6
6
7
The project and the repository are under construction.
Original file line number Diff line number Diff line change @@ -59,6 +59,17 @@ which is written using StrictDoc:
59
59
LEVEL: 1
60
60
TITLE: Getting started
61
61
62
+ [SECTION]
63
+ LEVEL: 2
64
+ TITLE: Requirements
65
+
66
+ [FREETEXT]
67
+ - Python 3.6+
68
+ - macOS, Linux or Windows
69
+ [/FREETEXT]
70
+
71
+ [/SECTION]
72
+
62
73
[SECTION]
63
74
LEVEL: 2
64
75
TITLE: Installing StrictDoc as a Pip package
@@ -76,11 +87,26 @@ LEVEL: 2
76
87
TITLE: Installing StrictDoc from GitHub (development)
77
88
78
89
[FREETEXT]
90
+ `Poetry <https://python-poetry.org>`_ has to be installed first.
91
+
79
92
.. code-block:: text
80
93
81
94
git clone git@github.com:stanislaw/strictdoc.git && cd strictdoc
82
95
poetry install
83
96
poetry run strictdoc
97
+ poetry run invoke test
98
+
99
+ StrictDoc can also be developed and run without Poetry:
100
+
101
+ .. code-block:: text
102
+
103
+ git clone git@github.com:stanislaw/strictdoc.git && cd strictdoc
104
+ # for running strictdoc:
105
+ pip install textx jinja2 docutils
106
+ python3 strictdoc/cli/main.py
107
+ # for running tests:
108
+ pip install invoke pytest pytidylib html5lib
109
+ invoke test
84
110
[/FREETEXT]
85
111
86
112
[/SECTION]
@@ -370,6 +396,10 @@ STATEMENT: StrictDoc shall work on macOS systems.
370
396
TITLE: Linux support
371
397
STATEMENT: StrictDoc shall work on Linux systems.
372
398
399
+ [REQUIREMENT]
400
+ TITLE: Windows support
401
+ STATEMENT: StrictDoc shall work on Windows systems.
402
+
373
403
[/COMPOSITE-REQUIREMENT]
374
404
375
405
[REQUIREMENT]
@@ -729,16 +759,6 @@ STATEMENT: StrictDoc shall support rendering text/code blocks into RST syntax.
729
759
730
760
[/SECTION]
731
761
732
- [SECTION]
733
- LEVEL: 3
734
- TITLE: Platform support
735
-
736
- [REQUIREMENT]
737
- TITLE: Windows support
738
- STATEMENT: StrictDoc shall work on Windows systems.
739
-
740
- [/SECTION]
741
-
742
762
[SECTION]
743
763
LEVEL: 3
744
764
TITLE: Traceability and coverage
You can’t perform that action at this time.
0 commit comments