Merge pull request #24 from jasonyang-ee/doc

Update help menu and using book action

.github/workflows/mdbook.yml

@@ -0,0 +1,49 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches:
+      - "doc"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    env:
+      MDBOOK_VERSION: 0.4.36
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install mdBook
+        run: |
+          curl --proto '=https' --tlsv1.2 https://sh.rustup.rs -sSf -y | sh
+          rustup update
+          cargo install --version ${MDBOOK_VERSION} mdbook
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v4
+      - name: Build with mdBook
+        run: mdbook build
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: ./docs
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

README.md

@@ -1,5 +1,5 @@
 [![Test](https://github.com/jasonyang-ee/STM32-Dockerfile/actions/workflows/test.yml/badge.svg)](https://github.com/jasonyang-ee/STM32-Dockerfile/actions/workflows/test.yml)
-[![Upload](https://github.com/jasonyang-ee/STM32-Dockerfile/actions/workflows/push.yml/badge.svg)](https://github.com/jasonyang-ee/STM32-Dockerfile/actions/workflows/push.yml)
+[![Upload](https://github.com/jasonyang-ee/STM32-Dockerfile/actions/workflows/upload.yml/badge.svg)](https://github.com/jasonyang-ee/STM32-Dockerfile/actions/workflows/upload.yml)
 
 # Docker Container for STM32 CMake & Ninja Compiling
 
@@ -29,7 +29,8 @@
 - `5.8`: Name change to stm32-builder: ubuntu-latest :alpine-latest :arch-latest. Some Bug fix.
 - `6.0`: True multiplatform support on Ubuntu and Debian. Alpine and Archlinux for amd64 only.
 - `7.0`: Using better argrument parser. *API NOT COMPATIBLE WITH PREVIOUS VERSION*
-- `Latest`: `7.0`
+- `7.1`: Bug fixs. Help menu update.
+- `Latest`: `7.1`
 
 
 
@@ -51,6 +52,23 @@ For CMake setup, refer to the below STM32 project template.
 https://github.com/jasonyang-ee/STM32-CMAKE-TEMPLATE.git
 
 
+## Help Menu
+
+```
+docker run jasonyangee/stm32-builder:ubuntu-latest --help                              
+```
+>```bash
+>Usage: build.sh [OPTIONS]
+>Options:
+>  -h, --help                            Print this help message
+>  -t, --type <build type>               Set CMake build type
+>                                        Default: Release
+>  -v, --volume <volume mount path>      Path to mount project inside of container and cmake will build in this path
+>                                        Default: /home
+>  -r, --repo <repository url>           Clone repository from url into volume path and build
+>```
+
+
 ## Public Registry:
 
 > ghcr.io/jasonyang-ee/stm32-builder:ubuntu-latest

book.toml

@@ -1,6 +1,6 @@
 [book]
 title = "STM32 Docker Dev Container Documentation"
-authors = ["Jason Teng"]
+authors = ["Jason Yang"]
 language = "en"
 multilingual = false
 src = "docs_src/page"

build.sh

@@ -62,7 +62,7 @@ if [[ $HELP == true ]]; then
 	echo "  -t, --type <build type>               Set CMake build type"
 	echo "                                        Default: Release"
 	echo "  -v, --volume <volume mount path>      Path to mount project inside of container and cmake will build in this path"
-	echo "										  Default: /home"
+	echo "                                        Default: /home"
 	echo "  -r, --repo <repository url>           Clone repository from url into volume path and build"
 	echo ""
 	echo "Example:"