Skip to content

Commit 2fb19bb

Browse files
committed
Added link to tutorial
1 parent 896f500 commit 2fb19bb

1 file changed

Lines changed: 5 additions & 3 deletions

File tree

README.adoc

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,17 @@
11
= Getting Started with Commodore Components
22

3-
This tutorial provides all the information required to create your first Commodore component.
3+
This tutorial provides all the information required to create your first Commodore component. https://syn.tools/tuto/index.html[This tutorial can be found] in the official Project Syn documentation.
44

55
== Contents
66

7-
The contents of the tutorial are in the `tutorial.adoc` file. The scripts help encapsulate the knowledge required to spin up a Project Syn installation with at least 2 clusters.
7+
The contents of the tutorial are in the `docs/modules/ROOT/pages/index.adoc` file. The scripts help encapsulate the knowledge required to spin up a Project Syn installation with at least 2 clusters.
8+
9+
The instructions of the tutorial guide the user to the creation and deployment of a simple component.
810

911
== Requirements
1012

1113
The `0_requirements.sh` script shows the current versions of all required software.
1214

1315
== Build PDF
1416

15-
Use the `make pdf` command to create a PDF file out of the source Asciidoc file. This requires Docker.
17+
Use the `make pdf` command to create a PDF file out of the source Asciidoc file in the `build` folder. This operation requires Docker.

0 commit comments

Comments
 (0)