Skip to content

Commit

Permalink
Documentation updated
Browse files Browse the repository at this point in the history
  • Loading branch information
Cyb10101 committed Oct 12, 2019
1 parent 775f136 commit 6527869
Show file tree
Hide file tree
Showing 7 changed files with 52 additions and 64 deletions.
21 changes: 19 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,25 @@
# Sound board

A board with buttons to play funny sounds.
![GitHub package.json version](https://img.shields.io/github/package-json/v/cyb10101/electron_sound-board)

A colleague comes to you with a questionable request and you answer with a funny sound of your board!

![Sound Board Intro](assets/images/screenshots/sound-board-intro.gif)

## Download

> Note: Currently the program is not signed.
> Therefore, most antivirus programs will recognize the software as harmful.
> If that happens, you will need to whitelist the software.
>
> ![GitHub issue/pull request detail](https://img.shields.io/github/issues/detail/title/Cyb10101/electron_sound-board/5)

| Windows | Linux | Mac |
|:---:|:---:|:---:|
| - | - | ![GitHub issue/pull request detail](https://img.shields.io/github/issues/detail/title/Cyb10101/electron_sound-board/16) |

## Documentation

* [Add own sounds](docs/add-own-sounds.md)
* [Using the App](docs/using-the-application.md)
* [Development](docs/development.md)
Binary file added assets/images/screenshots/add-own-sounds.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/screenshots/keyboard-shortcuts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/screenshots/predefined-sounds.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/images/screenshots/sound-board-intro.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
62 changes: 0 additions & 62 deletions docs/add-own-sounds.md

This file was deleted.

33 changes: 33 additions & 0 deletions docs/using-the-application.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Using the Application

## Keyboard shortcuts

![Keyboard shortcuts](../assets/images/screenshots/keyboard-shortcuts.png)

You can control the first 10 sounds using keyboard shortcuts.

To do this, set the desired modifiers in the settings and then press the key combinations.

In the case of the picture that would be Ctrl + Shift + 1.

The order of the numbers is 1, 2, 3, 4, 5, 6, 7, 8, 9, 0.

The Num-Pad cannot be used at the moment.

## Edit board & Predefined sounds

![Add own sounds](../assets/images/screenshots/predefined-sounds.gif)

In the Edit section to the board below, you can add predefined sounds.

At the top you can edit the board. There you can move or delete your sounds. If you delete your own sounds, you have to add them again.

## Add own sounds

![Add own sounds](../assets/images/screenshots/add-own-sounds.png)

You can theoretically choose as sounds or images any file format available on the web.
However, I have limited the selection to the standard file formats.
If a format is missing just create an issue or a pull request.

As `icon` you can use anything that exists from [Font Awesome](https://fontawesome.com/) free package.

0 comments on commit 6527869

Please sign in to comment.