Skip to content

Commit

Permalink
Merge branch 'prep-release'
Browse files Browse the repository at this point in the history
  • Loading branch information
agateau committed Jan 12, 2022
2 parents 034cbe5 + 42665e0 commit 1cdbf67
Show file tree
Hide file tree
Showing 4 changed files with 43 additions and 40 deletions.
48 changes: 32 additions & 16 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,25 @@
# Changelog

## 1.4.0 - 2022-01-12

### Added

- SFXR-Qt can now export wavs from the command line (#9) (Linus Vana).
- Added tooltips (Aurelien Gateau).
- Implemented "Randomize", based on the original SFXR code (Aurelien Gateau).
- Make it possible to load sounds from the command line (Aurelien Gateau).

### Fixed

- Fixed crash when clicking too fast on the remove button (#8) (Aurelien Gateau).
- Fixed build on big-endian machines (#7) (Aurelien Gateau).

### Internal

- Reorganized source tree to match cookiecutter-qt-app layout (Aurelien Gateau).
- Updated clang-format config to group and sort includes (Aurelien Gateau).
- Use GitHub Actions (Aurelien Gateau).

## 1.3.0 - 2019-09-15

### Added
Expand All @@ -10,36 +30,33 @@

### Changed

- Open and save file dialogs now show an error message when something went
wrong.
- Open and save file dialogs now show an error message when something went wrong.

### Internal

- Internal cleanups:
- Ported loading and saving code from FILE to QFile.
- Applied my coding style.
- Split the code into a static lib and an app.
- Added tests.
- Cleaned some float vs qreal warnings.
- Ported loading and saving code from FILE to QFile.
- Applied my coding style.
- Split the code into a static lib and an app.
- Added tests.
- Cleaned some float vs qreal warnings.

## 1.2.0 - 2018-10-29

### Added

- Added a "Save" button.
- You can now open the file-open dialog with Ctrl+O and the file-save dialog
with Ctrl+S.
- You can now open the file-open dialog with Ctrl+O and the file-save dialog with Ctrl+S.
- Show real filename in sound buttons.

### Changed

- Rework noise buffer so that output is reproducible: when looping the same
sound should be replayed.
- Rework noise buffer so that output is reproducible: when looping the same sound should be replayed.
- Draw a thin line in the middle of bipolar sliders.

### Fixed

- Follow OS color theme, making the application usable if the theme is dark.
- Fixed invisible "close sound" button by using a different symbol, which works
in all tested themes.
- Fixed invisible "close sound" button by using a different symbol, which works in all tested themes.
- Make sure user interface elements do not overlap.
- Fixed pip install doc (thanks to feinstaub).
- Workaround for a bug with Slider which made it behave strangely when values
Expand All @@ -48,8 +65,7 @@
## 1.1.0 - 2018-02-09

### Added
- Multiple sound support: clicking on a generator button creates a new sound.
You can switch between the different sounds and easily drop the bad ones.
- Multiple sound support: clicking on a generator button creates a new sound. You can switch between the different sounds and easily drop the bad ones.

- Added a way to play a sound in loop.

Expand Down
2 changes: 1 addition & 1 deletion CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
cmake_minimum_required(VERSION 3.17)
project(sfxr-qt
VERSION 1.3.0
VERSION 1.4.0
DESCRIPTION "Retro sound effect generator"
HOMEPAGE_URL "https://github.com/agateau/sfxr-qt"
)
Expand Down
29 changes: 8 additions & 21 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,19 @@

![Screenshot](screenshot.png)

This a QtQuick Controls 2 port of [SFXR][]. SFXR is a sound effect generator
created by DrPetter to quickly produce retro-sounding sound effects for games.
This a QtQuick Controls 2 port of [SFXR][]. SFXR is a sound effect generator created by DrPetter to quickly produce retro-sounding sound effects for games.

This project has the same features as the original SFXR, with a more modern
user interface and, dare I say, a more modular code base. Meaning DrPetter did
all the hard work, I just refactored and plugged a new UI on top of it.
This project has the same features as the original SFXR, with a more modern user interface and, dare I say, a more modular code base. Meaning DrPetter did all the hard work, I just refactored and plugged a new UI on top of it.

## Usage

Start the application and click on one of the generator buttons. Then play with
the sliders to produce the sound you want. When you are happy with the result,
use the "Export as..." button to create a wav file, or the "Save as..." button
to save it in [SFXJ format][format], so that you can work on it later.
Start the application and click on one of the generator buttons. Then play with the sliders to produce the sound you want. When you are happy with the result, use the "Export as..." button to create a wav file, or the "Save as..." button to save it in [SFXJ format][format], so that you can work on it later.

[format]: docs/file-formats.md

For more details, you should read the original [SFXR
readme.txt](readme-sfxr-sdl.txt).
For more details, you should read the original [SFXR readme.txt](readme-sfxr-sdl.txt).

You can also use the `--export` option to export your SFXR or SFXJ files to wav
files from the command-line. Look at the output of `sfxr-qt --help` for
details.
You can also use the `--export` option to export your SFXR or SFXJ files to wav files from the command-line. Look at the output of `sfxr-qt --help` for details.

## Precompiled binaries

Expand All @@ -40,19 +31,15 @@ Building SFXR Qt requires installing the following tools:
- A C++ 17 compiler
- Qt 5.7
- SDL 1.2
- CMake 3.10 (You might be able to build with older versions if you adjust the
minimum version in the `CMakeLists.txt` file, let me know if you do)
- CMake 3.17 (You might be able to build with older versions if you adjust the minimum version in the `CMakeLists.txt` file, let me know if you do)

### Step 2

Building SFXR Qt also requires [qpropgen][], a tool to generate Qt properties.
For now qpropgen is bundled as a Git submodule, so first get the `qpropgen` Git
submodule with:
Building SFXR Qt also requires [qpropgen][], a tool to generate Qt properties. For now qpropgen is bundled as a Git submodule, so first get the `qpropgen` Git submodule with:

git submodule update --init

qpropgen is written in Python 3, so make sure you have Python 3 and pip
installed, then run:
qpropgen is written in Python 3, so make sure you have Python 3 and pip installed, then run:

pip3 install -r qpropgen/requirements.txt

Expand Down
4 changes: 2 additions & 2 deletions docs/release-check-list.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@ Check working tree is up to date and clean:
git checkout master
git status

Bump version number in CMakeLists.txt

Update CHANGELOG.md:

r!git log --pretty=format:'- \%s (\%an)' x.y.z-1..HEAD

Bump version number in CMakeLists.txt

Update README and docs

Build packages:
Expand Down

0 comments on commit 1cdbf67

Please sign in to comment.