Skip to content

Commit a893073

Browse files
committed
readme: add how it works section
1 parent ab4c976 commit a893073

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,16 @@
77
Przed Państwem kod źródłowy mojej strony z notatkami z matematyki.
88
Zapraszam do oglądania i komentowania!
99

10+
## How it works?
11+
12+
- I write markdown locally (If I need I build it using `make html`).
13+
- I commit changes and push them to this repository.
14+
- First layer of my CI/CD pipeline is triggered by push event. It does the following:
15+
- some automation happens to put all the source together (include all files in subdirectories of `assets/notes`). It also updates commit hash/name/date at the bottom of the website.
16+
- it builds the html content from sphinx project and pushes it to `gh-pages` branch (this branch has nothing to do with `master` - it has completely different content).
17+
- this push triggers the built-in GitHub workflow that does its magic things so that my page hosted via github is updated.
18+
- the second step of my CI/CD pipeline (parallel to the above) aims to generate a PDF document from the same source. It is also pushed but this time to `pdf` branch where it could be downloaded via a green scammy-looking button on top of this readme.
19+
1020
## Instalacja
1121

1222
Część plików nie jestd dodawana do git'a. Generują się same po użyciu dowolnej komendy z Makefile'a.

0 commit comments

Comments
 (0)