Skip to content

Commit

Permalink
Added: FAQ section to README.md file.
Browse files Browse the repository at this point in the history
  • Loading branch information
sven.seyfert committed Feb 10, 2022
1 parent 07fa391 commit 80fdeb8
Show file tree
Hide file tree
Showing 4 changed files with 44 additions and 8 deletions.
13 changes: 13 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
35 changes: 29 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -46,18 +46,41 @@ Then, run or compile the program.

To be defined [...]

## Configuration

To be defined [...]

## Keyboard Shortcuts
#### *Keyboard Shortcuts*

| Action | Shortcut |
| :--- | :--- |
| Increase visibility | `Alt+Numpad+` |
| Decrease visibility | `Alt+Numpad-` |
| Close program | `Alt+Numpad5` |

## Configuration

To be defined [...]

## FAQ

<details>
<summary><i>Frequently Asked Questions</i></summary><br>

<details>
<summary><code>1. How to [...]</code></summary><p>

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

<br></p></details>

<details>
<summary><code>2. How to [...]</code></summary><p>

**Q:** [...]?<br>
**A:** [...].

<br></p></details>

</details>

## Contributing

Just look at [CONTRIBUTING](https://github.com/Sven-Seyfert/Au3VidOverlay/blob/master/docs/CONTRIBUTING.md), thank you!
Expand Down
Binary file modified build/Au3VidOverlay.exe
Binary file not shown.
4 changes: 2 additions & 2 deletions src/Au3VidOverlay.au3
Original file line number Diff line number Diff line change
@@ -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
Expand Down

0 comments on commit 80fdeb8

Please sign in to comment.