From 80fdeb87fdf728e4a4d9187602dd98a0c7172d32 Mon Sep 17 00:00:00 2001 From: "sven.seyfert" Date: Thu, 10 Feb 2022 21:58:14 +0100 Subject: [PATCH] Added: FAQ section to README.md file. --- CHANGELOG.md | 13 +++++++++++++ README.md | 35 +++++++++++++++++++++++++++++------ build/Au3VidOverlay.exe | Bin 1122816 -> 1122816 bytes src/Au3VidOverlay.au3 | 4 ++-- 4 files changed, 44 insertions(+), 8 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index e6ac2b1..056fa68 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,18 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 Go to [legend](#legend---types-of-changes) for further information about the types of changes. +## [1.3.0] - 2022-02-10 + +### Added + +- Links to the project badges/icons. +- FAQ section to README.md file. + +### Changed: + +- Move "Keyboard shortcuts" section into "Getting started" section (as sub section after "Usage"). +- Version bump. + ## [1.2.0] - 2022-02-09 ### Changed @@ -39,6 +51,7 @@ Go to [legend](#legend---types-of-changes) for further information about the typ - AutoIt Code formatting to the common notation without additional spaces after opened brackets and before closed brackets. +[1.3.0]: https://github.com/Sven-Seyfert/Au3VidOverlay/compare/v1.2.0...v1.3.0 [1.2.0]: https://github.com/Sven-Seyfert/Au3VidOverlay/compare/v1.1.0...v1.2.0 [1.1.0]: https://github.com/Sven-Seyfert/Au3VidOverlay/compare/v1.0.0...v1.1.0 [1.0.0]: https://github.com/Sven-Seyfert/Au3VidOverlay/releases/tag/v1.0.0 diff --git a/README.md b/README.md index 68f8fa1..0a31ff7 100644 --- a/README.md +++ b/README.md @@ -13,7 +13,7 @@ ![os](https://img.shields.io/badge/os-windows-yellow.svg?style=flat-square&logo=windows) ![editor](https://img.shields.io/badge/editor-VSCode-blueviolet.svg?style=flat-square&logo=visual-studio-code) -[Description](#description) | [Features](#features) | [Getting started](#getting-started) | [Configuration](#configuration) | [Keyboard shortcuts](#keyboard-shortcuts) | [Contributing](#contributing) | [License](#license) | [Acknowledgements](#acknowledgements) +[Description](#description) | [Features](#features) | [Getting started](#getting-started) | [Configuration](#configuration) | [FAQ](#faq) | [Contributing](#contributing) | [License](#license) | [Acknowledgements](#acknowledgements) ## Description @@ -46,11 +46,7 @@ Then, run or compile the program. To be defined [...] -## Configuration - -To be defined [...] - -## Keyboard Shortcuts +#### *Keyboard Shortcuts* | Action | Shortcut | | :--- | :--- | @@ -58,6 +54,33 @@ To be defined [...] | Decrease visibility | `Alt+Numpad-` | | Close program | `Alt+Numpad5` | +## Configuration + +To be defined [...] + +## FAQ + +
+Frequently Asked Questions
+ +
+ 1. How to [...]

+ + **Q:** Is there a frequently asked question already?
+ **A:** No, not yet. + +

+ +
+ 2. How to [...]

+ + **Q:** [...]?
+ **A:** [...]. + +

+ +
+ ## Contributing Just look at [CONTRIBUTING](https://github.com/Sven-Seyfert/Au3VidOverlay/blob/master/docs/CONTRIBUTING.md), thank you! diff --git a/build/Au3VidOverlay.exe b/build/Au3VidOverlay.exe index 8b0b559bf271727c457a533dde2a2bfbbaba1ce2..803ef98001ac84eb57befcba9cfae9a573436f37 100644 GIT binary patch delta 236 zcmZoT;?i)$WrGAGvtteGWNAiUrpeaLS&Z#jj3CSe#LPg<0>rF9%m&2lK+FNeoIuP4 z#N0s41H`;Q%m>8$+p`!2id1xUxtH6De)w2@E8_owhZ|ONGwf++0OOWr3=9Y4ZZNjD z)Lwc`y=CQx}n;_Y=>D%;mY65ZsAgQ04RbVAjv9(vX-%%5|@Pd<>fsp|On5S>$ t7u?TiJiSyvaJ{@SgC2tcg93vt5E}tmMnI?wrga$%84R{N3kvQP0013KNSpuw delta 236 zcmZoT;?i)$WrGAGbFDthWNAiUCh4~3EXMXMMi6EKVrC#_0b*7lW&>h&Am#vKP9Ww2 zVs0Sj0b*Vt<^y8>?OBWhMJl@b+>2~wKD1Wfiuixv;fB@R413xcz_?`@1H&)b8;m6~f;^VnbfO_ThyscHH;H32yRkkril46qW`#o4vn@2Ck}c)`iUz{mgsOw+gW q3+`t$nqDd(xL)3fL65d_OBOufT(;(7vyR)F+UI75zI!HnQ diff --git a/src/Au3VidOverlay.au3 b/src/Au3VidOverlay.au3 index dd9e6d5..7cddabf 100644 --- a/src/Au3VidOverlay.au3 +++ b/src/Au3VidOverlay.au3 @@ -1,9 +1,9 @@ ; compiler information for AutoIt #pragma compile(CompanyName, © SOLVE SMART) -#pragma compile(FileVersion, 1.2.0) +#pragma compile(FileVersion, 1.3.0) #pragma compile(LegalCopyright, © Sven Seyfert) #pragma compile(ProductName, Au3VidOverlay) -#pragma compile(ProductVersion, 1.2.0 - 2022-02-09) +#pragma compile(ProductVersion, 1.3.0 - 2022-02-10) #AutoIt3Wrapper_AU3Check_Stop_OnWarning=y #AutoIt3Wrapper_Icon=..\media\favicon.ico