Skip to content

Commit 98a8755

Browse files
committed
README: add Windows CI badge
1 parent 18b43cd commit 98a8755

File tree

2 files changed

+31
-10
lines changed

2 files changed

+31
-10
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,6 @@
22

33
![](https://github.com/stanislaw/strictdoc/workflows/StrictDoc%20on%20macOS/badge.svg)
44
![](https://github.com/stanislaw/strictdoc/workflows/StrictDoc%20on%20Linux/badge.svg)
5+
![](https://github.com/stanislaw/strictdoc/workflows/StrictDoc%20on%20Windows/badge.svg)
56

67
The project and the repository are under construction.

docs/strictdoc.sdoc

Lines changed: 30 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,17 @@ which is written using StrictDoc:
5959
LEVEL: 1
6060
TITLE: Getting started
6161

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+
6273
[SECTION]
6374
LEVEL: 2
6475
TITLE: Installing StrictDoc as a Pip package
@@ -76,11 +87,26 @@ LEVEL: 2
7687
TITLE: Installing StrictDoc from GitHub (development)
7788

7889
[FREETEXT]
90+
`Poetry <https://python-poetry.org>`_ has to be installed first.
91+
7992
.. code-block:: text
8093

8194
git clone git@github.com:stanislaw/strictdoc.git && cd strictdoc
8295
poetry install
8396
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
84110
[/FREETEXT]
85111

86112
[/SECTION]
@@ -370,6 +396,10 @@ STATEMENT: StrictDoc shall work on macOS systems.
370396
TITLE: Linux support
371397
STATEMENT: StrictDoc shall work on Linux systems.
372398

399+
[REQUIREMENT]
400+
TITLE: Windows support
401+
STATEMENT: StrictDoc shall work on Windows systems.
402+
373403
[/COMPOSITE-REQUIREMENT]
374404

375405
[REQUIREMENT]
@@ -729,16 +759,6 @@ STATEMENT: StrictDoc shall support rendering text/code blocks into RST syntax.
729759

730760
[/SECTION]
731761

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-
742762
[SECTION]
743763
LEVEL: 3
744764
TITLE: Traceability and coverage

0 commit comments

Comments
 (0)