Skip to content

Commit aaea14d

Browse files
committed
Updated Readme.md
1 parent 90ade86 commit aaea14d

File tree

1 file changed

+23
-10
lines changed

1 file changed

+23
-10
lines changed

ReadMe.md

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
[link_projects]: https://github.com/BenPyton/SoundGenerator/projects/1
2+
[link_issues]: https://github.com/BenPyton/SoundGenerator/issues
3+
[link_pullRequest]: https://github.com/BenPyton/SoundGenerator/pulls
4+
15
# Sound Generator with Nodal Interface
26

37
I don't have a good name at this time, but this software will be renamed later.
@@ -9,38 +13,47 @@ I don't have a good name at this time, but this software will be renamed later.
913
This software is a nodal editor that allow you to create sounds from several generators (sine wave, square wave, etc.)
1014
and modulate them (frequency, amplitude, etc.) and modify them (delay, repeat, etc.).
1115

16+
### Warnings
1217
**This is currently in alpha version.**<br>
13-
It still lack of common features (copy/paste, undo/redo, etc.) and components (there a lot more to be done).
14-
But the software is fully functionnaland have all the core features.
18+
It still lack of features and components: there a lot more to be done.<br>
19+
But the software is fully functionnal and have all the core features.<br>
20+
See the [roadmap to beta version][link_projects] to get an idea of what is still to be done.
1521

1622
**There is currently only Windows 8/10 builds**<br>
17-
If you want this software on other platform, please download Qt and build it yourself.<br>
23+
If you want this software on other platform, please download Qt and build it yourself (see the [Technical Informations](#technical-informations) section to get Qt).<br>
1824
You can also contribute by providing your build to share it with other people.
1925

2026
## Controls
2127
Press any buttons from the left side to add a component in the scene.<br>
22-
You can also drag and drop from one of those button to add a component at a position.<br>
28+
You can also drag and drop from one of those buttons to add a component at a position.<br>
2329
Or you can `right click > add` in the scene to add a component at a position.
2430

2531
You can select components with `mouse left button` and drag them around the scene.<br>
26-
You can delete selected components with `right click > remove` or by pressing `delete`.<br>
32+
You can delete selected components with `right click > remove` or by pressing `delete` key.<br>
2733
(note that the output component cannot be removed)<br>
2834

2935
Press a component pin with `left mouse button` and hold it until you release it on another pin.<br>
3036
An output pin cannot be connected to another output pin (same for input pins), and you cannot connect components in a loop.<br>
3137

32-
In order to play a sound, you have to generate it with the menu `Audio > Generate` or by pressing `F5`.
38+
In order to play a sound, you have to generate it with the menu `Audio > Generate` or by pressing `F5`.<br>
39+
You can auto-generate the sound when play button is pressed, or when a modification is made, in the audio menu.
40+
41+
Common shortcuts:
42+
- Ctrl+A: select all the components;
43+
- Ctrl+C/Ctrl+V: copy/paste components (except the output);
44+
- Ctrl+Z/Ctrl+Y: undo/redo your modifications.
3345

3446
## Features
3547
- Base sound signals : Sinus, Square, Triangle, Sawtooth, Random (White noise);
3648
- Mix sound signals with operators like Add, Multiply;
3749
- Modify sound signals with Delay, Repeat and ADSR;
38-
- Save and load editor projects;
50+
- Save and load projects;
3951
- Save resulting sound in wav file.
4052

41-
Visit the [planned features](https://github.com/BenPyton/SoundGenerator/projects/1) to see what are the next features to come.
53+
Visit the [planned features][link_projects] to see what are the next features to come.<br>
54+
**Warning**: this project is made on my freetime, so it can take a while before releasing a new version.
4255

43-
If you think of another feature, or you found bugs, please go to the [issue panel](https://github.com/BenPyton/SoundGenerator/issues) to report it, or fix it yourself and do a [Pull Request](https://github.com/BenPyton/SoundGenerator/pulls) to contribute to the software.<br>
56+
If you think of another feature, or you found bugs, please go to the [issue panel][link_issues] to report it, or fix it yourself and do a [Pull Request][link_pullRequest] to contribute to the software.<br>
4457
(Be careful of the licenses from Qt and this software if you modify it for your own purpose)
4558

4659
## Technical informations
@@ -53,5 +66,5 @@ You can use another version of Qt or QtCreator but I cannot guarranty that it ca
5366
## License
5467
<img src="https://www.gnu.org/graphics/gplv3-with-text-136x68.png"/><br>
5568
This project is under GNU General Public License (GPLv3) version 3.<br>
56-
Copyright (c) 2019 Benoît Pelletier<br>
69+
Copyright (c) 2019-2020 Benoît Pelletier<br>
5770
Please refer to this software license text [here](LICENSE), and third party attributions [here](attributions.md).

0 commit comments

Comments
 (0)