Merge branch '2-docs-build-github-pages-site-for-h5cpp-compiler' into release

Author: steven-varga

.github/workflows/docs.yml

@@ -0,0 +1,34 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches: [release, staging]
+
+permissions:
+  contents: write 
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.x'
+
+      - name: Install MkDocs + Material theme
+        run: |
+          pip install mkdocs mkdocs-material
+
+      - name: Build documentation
+        run: mkdocs build
+
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./site

README.md

@@ -23,6 +23,14 @@ The result is a seamless persistence much similar to python, java or other refle
 
 The following excerpt shows the mechanism, how `vec` variable is marked by `h5::write` operator. When `h5cpp` tool is invoked it builds the full AST of the translation unit, finds the referenced types, then in topological order generates HDF5 COMPOUND datatype descriptors. The generated file has include guards, and meant to be used with [H5CPP template library](h5cpp.org). POD struct types may be arbitrary deep, embedded in POD C like arrays, and may be referenced from STL containers. Currently `stl::vector` is supported, but in time full support will be provided.
 
+## Installation
+```bash
+sudo apt install build-essential cmake
+cmake -DCMAKE_BUILD_TYPE=Release -S . -B build
+cmake --build build --parallel
+sudo cmake --install build
+```
+
 ```cpp
 ...
 std::vector<sn::example::Record> vec 
@@ -80,6 +88,29 @@ namespace sn {
 	/* END IGNORED STRUCTS */
 ```
 
+
+# Python virtual environment for this website
+
+## Setup
+
+```bash
+python3 -m venv .venv                 # Create a virtual env (Python 3.10+ recommended)
+source .venv/bin/activate             # Activate: Linux / macOS
+# On Windows use: .venv\Scripts\activate
+
+pip install --upgrade pip             # Upgrade pip
+pip install mkdocs-material           # Install MkDocs + Material theme
+pip install python-frontmatter jinja2 python-dateutil pyyaml  # Extra deps
+```
+
+## Run MkDocs locally
+
+```bash
+source .venv/bin/activate
+mkdocs serve --dev-addr=127.0.0.1:9000   # Live preview at http://127.0.0.1:9000
+mkdocs build -v                          # Build static site locally
+```
+
 <!-- Ubuntu 22.04 -->
 [200]: https://vargaconsulting.github.io/h5cpp-compiler/badges/ubuntu-22.04-gcc-13.svg
 [201]: https://vargaconsulting.github.io/h5cpp-compiler/badges/ubuntu-22.04-gcc-14.svg
@@ -110,4 +141,4 @@ namespace sn {
 [702]: https://vargaconsulting.github.io/h5cpp-compiler/badges/windows-latest-gcc-15.svg
 [710]: https://vargaconsulting.github.io/h5cpp-compiler/badges/windows-latest-clang-14.svg
 [711]: https://vargaconsulting.github.io/h5cpp-compiler/badges/windows-latest-clang-15.svg
-[712]: https://vargaconsulting.github.io/h5cpp-compiler/badges/windows-latest-clang-17.svg
+[712]: https://vargaconsulting.github.io/h5cpp-compiler/badges/windows-latest-clang-17.svg