Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
haiyaku365 committed Nov 17, 2023
1 parent a3f8546 commit 1f0b982
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 9 deletions.
8 changes: 8 additions & 0 deletions docs/Changelog.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# StimmingSignalGenerator
### Changelog:
#### v0.5.0.0
##### Changes
* Remove WaveOut audio API.
* Upgrade to .Net 8
* Various bug fix.
##### New
* Add PortAudio audio API.
---
#### v0.4.0.0
##### Changes
* On startup load last playlist instead of first playlist sort by file name.
Expand Down
15 changes: 6 additions & 9 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,13 +9,13 @@ This software basically generate real-time audio signal.

## Running StimmingSignalGenerator
#### To run on Windows
1. Install [.NET Core 3.1 Desktop Runtime](https://dot.net).
1. Install [.NET Desktop Runtime 8.0](https://dot.net).
2. Download binary in [releases page](https://github.com/haiyaku365/StimmingSignalGenerator/releases)
3. run exe

#### To run on Linux
1. Install [.NET Core 3.1 runtime](https://dot.net)
2. Install OpenAL lib
1. Install [.NET runtime 8.0](https://dot.net)
2. (optional)Install OpenAL lib
```
sudo apt install libopenal1
```
Expand All @@ -25,7 +25,7 @@ sudo apt install libopenal1
dotnet PathToApp/StimmingSignalGenerator.dll
```
#### To run from source
1. Install [.NET Core 3.1 SDK](https://dot.net)
1. Install [.NET SDK 8.0](https://dot.net)
2. clone
```
git clone https://github.com/haiyaku365/StimmingSignalGenerator.git
Expand Down Expand Up @@ -83,8 +83,5 @@ Use mouse scroll to zoom in, out.
#### Note
Note that save along with playlist.

#### ~~Default playlist~~
~~When startup it will load first playlist file sort by file name.~~
No default playlist anymore.
When startup it will load playlist you open before exit.

#### Audio API selection
Right click on play, stop button to select audio API.

0 comments on commit 1f0b982

Please sign in to comment.