Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ddanilov committed Nov 6, 2022
1 parent 68f8c5b commit f24bf61
Showing 1 changed file with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,26 @@
# soundscape-qt

Desktop application to play a combination of sounds, e.g. natural sounds
produced by animals or wind and water.
[![GitHub release](https://img.shields.io/github/release/ddanilov/soundscape-qt)](https://github.com/ddanilov/soundscape-qt/releases/)

[**soundscape-qt**](https://github.com/ddanilov/soundscape-qt) is an open source
desktop application to play a mix of sounds, e.g. natural sounds produced by
animals or wind and water.

## Usage

**soundscape-qt** itself comes with no sounds, however you can use example
soundscapes provided in
[soundscape-examples](https://github.com/ddanilov/soundscape-examples)
repository to test the functionality of the application. Load one of the
`*.json` files into the application, and it will import and play the included
media files. Use mouse right-click in the main window or on the tray icon to
access application menu where you can add or remove soundtracks and change their
settings.

[Freesound](https://freesound.org/) is a good source of sounds for your own
soundscapes.

## Installation

Prebuilt binaries for Microsoft Windows are avaiable from the
[Releases page](https://github.com/ddanilov/soundscape-qt/releases).

0 comments on commit f24bf61

Please sign in to comment.