Merge pull request #26 from MadScrewdriver/tutorials

Tutorials added

.github/workflows/bump-release.yml

@@ -11,9 +11,7 @@ jobs:
     runs-on: ubuntu-latest
 
     permissions:
-      # Give the default GITHUB_TOKEN write permission to commit and push the
-      # added or changed files to the repository.
-      contents: write
+      contents: write  # Grant write permissions
 
     steps:
       - name: Checkout code
@@ -26,22 +24,21 @@ jobs:
           git config --global user.email "[email protected]"
           git config --global user.name "Franciszek Łajszczak"
 
-
       - name: Set up Python
         uses: actions/setup-python@v3
         with:
-          python-version: 3.9 # Specify your desired Python version
+          python-version: 3.9
 
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
           pip install bump2version
-      
-
 
       - name: Bump version
         run: bumpversion patch --verbose --commit --no-tag
 
-      - name: Commit changes
+      - name: Push changes
+        env:
+          GH_PAT: ${{ secrets.GH_PAT }}
         run: |
-          git push origin main
+          git push "https://x-access-token:${GH_PAT}@github.com/${{ github.repository }}.git" main

README.md

@@ -46,6 +46,7 @@ The most common case is the installation by [**pip package manager**](https://pi
 ```
 
 ##  📐 DXF Parametrization
+Examples of parametrized DXF files can be found in the [**examples**](https://github.com/MadScrewdriver/qsketchmetric/tree/main/examples) directory.
 Parametrization is done using [**QCAD Professional software**](https://qcad.org/en/download). 
 You can download the [**free trial**](https://qcad.org/en/download) version of the software and use it for parametrization of your DXF files.
 We need to use it because it is the only software that supports adding custom data to DXF entities. 
@@ -79,6 +80,9 @@ place where the error occurred in the DXF file and the error message.
 -  Support for parametrization of `LWPOLYLINE`, `POLYLINE`, `SPLINE`, `ELLIPSE`, `MTEXT`, `TEXT` **etc.** entities using `INSERT` entity.
 -  Open source and daily maintained
 
+## 📺 YouTube tutorials
+YouTube tutorials are available at [**Tutorials playlist**](https://youtube.com/playlist?list=PLpVxwQmtfqH4TpyFuB5yyvXj0Zwru7Nl8&feature=shared)
+
 ## 📚 Documentation
 Documentation is available at [**QSketchMetric docs**](https://qsketchmetric.readthedocs.io/en/latest/)
 

docs/how_to_guide/index.rst

@@ -4,7 +4,8 @@ How-to guides
 =============
 
 :ref:`How-to guides <how-to-guides>` are recipes. They guide you through the steps involved in addressing key problems and use-cases.
-They are more advanced than tutorials and assume some knowledge of how QSketchMetric works.
+They are more advanced than tutorials and assume some knowledge of how QSketchMetric works. You can also check the
+YouTube channel for video how-to-guides `here <https://youtube.com/playlist?list=PLpVxwQmtfqH4TpyFuB5yyvXj0Zwru7Nl8&feature=shared>`_.
 
 .. toctree::
    :maxdepth: 1

docs/index.rst

@@ -1,8 +1,3 @@
-gitp.. qsketchmetric documentation master file, created by
-   sphinx-quickstart on Sun Aug 20 14:22:12 2023.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 
 .. image:: https://raw.githubusercontent.com/MadScrewdriver/qsketchmetric/main/docs/_static/Media/logo_QSM.png
 

docs/tutorials/index.rst

@@ -4,7 +4,8 @@ Tutorials
 =========
 
 :ref:`Tutorials <tutorials>` take you by the hand through a series of steps to start using QSketchMetric.
-Start here if you’re new to QSketchMetric.
+Start here if you’re new to QSketchMetric. You can also check the YouTube channel for video tutorials
+`here <https://youtube.com/playlist?list=PLpVxwQmtfqH4TpyFuB5yyvXj0Zwru7Nl8&feature=shared>`_.
 
 .. toctree::
    :maxdepth: 1