Skip to content

Commit e6db5d2

Browse files
TASK: Update readme
* To be consistent with new naming after transferring ownership to official TYPO3.
1 parent 219e164 commit e6db5d2

1 file changed

Lines changed: 14 additions & 10 deletions

File tree

Readme.rst

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,29 +3,33 @@
33
About
44
=====
55

6-
This repo should provide all parts to enable TYPO3 Documentation rendering through Gitlab CI.
6+
This repo provide all parts to enable TYPO3 Documentation rendering.
77

8-
You also can use this to render your documentation locally the same way.
8+
You also can use this to render your documentation locally.
9+
10+
It's also used in CI to render documentations.
911

1012
Requirements
1113
============
1214

1315
- Docker
1416

15-
Install
16-
=======
17-
18-
::
19-
20-
docker build -t danielsiepmann/t3docs-ci .
21-
2217
Usage
2318
=====
2419

2520
``cd`` into an extension folder, containing the ``Documentation`` folder.
2621

2722
Run::
2823

29-
docker run -v "$PWD":/tmp/makedir danielsiepmann/t3docs-ci
24+
docker run -v "$PWD":/tmp/makedir t3docs/renderdocumentation
3025

3126
The results are inside the new ``build`` folder.
27+
28+
Install
29+
=======
30+
31+
By running the docker image, Docker will pull it if not already persent.
32+
33+
If you want to build the docker image locally, clone the repository and run::
34+
35+
docker build -t t3docs/renderdocumentation .

0 commit comments

Comments
 (0)