Report Issue Request Feature

Table of Contents

• Description
  • Features
  • Status
    • Repo
    • Readme
    • Markdown files
• Installation
  • Dependencies
  • folder structure
  • Usage/Examples
• API Reference
  • Inputs
  • Outputs
  • Parameters
• Documentation
  • Architecture
    • Github
      • Github Repo
      • Github Actions / Workflows
  • Application
  • DevOps
  • Github Page
  • Github Wiki
  • Comments
  • Screenshots
• Authors and License
  • License
  • Authors
    • Code Contributors

Description

QT6 CXX20 prep read dir recursive and some Github workflows and Github actions.

Preparation for a project

Features

• [x] MIT license
• [x] works as designed
• [ ] no bugs
• [x] some more or less usefull Github Actions

Status

Repo

Readme

Markdown files

create ToC in Markdown files in folders

• .github/actions/**
• .github/workflows/**
• dist/**
• docs/**

Installation

bla bla ... everything easy and green with No Code/Low code and without any costs

Dependencies

bla bla ... with a little help from my friends

folder structure

.
├── .github
│   ├── actions
│   │   └── doctoc
│   │       ├── README.md
│   │       ├── action.yml
│   │       └── dist
│   │           ├── index.js
│   │           ├── index.js.map
│   │           ├── licenses.txt
│   │           └── sourcemap-register.js
│   └── workflows
│       ├── repo-actions_docu.yml
│       ├── repo-call_Readme.yml
│       ├── repo-create_doctoc.yml_
│       ├── repo-create_doctoc_md.yml
│       └── repo-create_tree_readme.yml
├── .gitignore
├── LICENSE
├── README.md
├── main.cpp
├── qt_readdir_rek.pro
└── tree.bak

5 directories, 17 files

Usage/Examples

bla bla ... usage is intuitive and runs mostly automatically with no needs of any knowledge

<mark> under construction </mark>

API Reference

Inputs/Outputs will be filled automatically by .github/workflows/repo-actions_docu.yml

Inputs

Outputs

Parameters

Workflow or program

Documentation

see also: https://linktodocumentation

Architecture

Github

Github Repo

block-beta
  columns 4
  Repo:4
  block:group1:1
    columns 1
    id0[".github"]
    block:group2:1
      columns 1
      id1[["workflows"]]
      id2[["actions"]]
    end
  end
  docs dist src
  block:group3:4
    %% columns auto (default)
    A["gh-pages"] B["gh-wiki"]
  end

Github Actions / Workflows

flowchart TD;
    A[Workflow]-. parameter .->B[[callable Workflow]]
    B-- parameter -->C[Action]
    C-->D(README)

    A[Workflow]-. parameter .->E[[callable Workflow]]
    E-- parameter -->F[Action]
    F-->J(Markdown files)

    A[Workflow]-->K[[Workflow]]
    K-->L[Action]
    L-->M("GH-Pages")

    A[Workflow]-->N[[Workflow]]
    N-->O[Action]
    O-->P("GH-Wiki")

Application

architecture-beta
    group api(cloud)[API]

    service db(database)[Database] in api
    service server0(server)[Webserver] in api
    service disk2(disk)[Storage] in api
    service server(server)[Appserver] in api

    db:L -- R:server
    server0:T -- B:server
    disk2:T -- B:server

DevOps

pie title me
         "ideas" : 90
         "time for realizations" : 7
         "money for realizations" : 3

Github Page

Github Wiki

Comments

[!NOTE] Useful information that users should know, even when skimming content.

[!TIP] Helpful advice for doing things better or more easily.

[!IMPORTANT] Key information users need to know to achieve their goal.

[!WARNING] Urgent info that needs immediate user attention to avoid problems.

[!CAUTION] Advises about risks or negative outcomes of certain actions.

Screenshots

Authors and License

License

Copyright (c) 2024 ZHENG Robert

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

    https://choosealicense.com/licenses/mit/

Authors

Code Contributors

🖖