mirror/sointu
1
0
Fork 0
mirror of https://github.com/vsariola/sointu.git synced 2025-07-18 13:04:25 -04:00
Code Issues Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
vsariola
2021-03-04 18:05:18 +02:00
parent b7c326a0a7
commit 062180db1e
1 changed files with 14 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

28
README.md
View File

@ -27,7 +27,7 @@ Sointu consists of two core elements:
- A cross-platform synth-tracker app for composing music, written in - A cross-platform synth-tracker app for composing music, written in
[go](https://golang.org/). The app is still heavily work in progress. The app [go](https://golang.org/). The app is still heavily work in progress. The app
exports the projects as .yml files. There are two versions of the app: exports the projects as .yml files. There are two versions of the app:
[cmd/sointu-track/](sointu-track), using a pure-Go VM bytecode interpreter, [cmd/sointu-track/](sointu-track), using a plain Go VM bytecode interpreter,
and [cmd/sointu-nativetrack/](sointu-nativetrack), using cgo to bridge calls and [cmd/sointu-nativetrack/](sointu-nativetrack), using cgo to bridge calls
to the Sointu compiled VM. The former should be highly portable, the latter to the Sointu compiled VM. The former should be highly portable, the latter
currently works only on x86/amd64 platforms. currently works only on x86/amd64 platforms.
@ -49,7 +49,8 @@ listed below.
### Sointu-track ### Sointu-track
Running the tracker: This version of the tracker is the version that uses the bytecode interpreter
written in plain Go. Running the tracker:
``` ```
go run cmd/sointu-track/main.go go run cmd/sointu-track/main.go
@ -63,10 +64,9 @@ go build -o sointu-track cmd/sointu-track/main.go
On windows, replace `-o sointu-track` with `-o sointu-track.exe`. On windows, replace `-o sointu-track` with `-o sointu-track.exe`.
The uses the [gioui](https://gioui.org/) for the GUI and Sointu-track uses the [gioui](https://gioui.org/) for the GUI and
[oto](https://github.com/hajimehoshi/oto) for the audio, so the portability is [oto](https://github.com/hajimehoshi/oto) for the audio, so the portability is
currently limited by these. This version of the executable uses the bytecode currently limited by these.
interpreter written in Go.
> :warning: Unlike the x86/amd64 VM compiled by Sointu, the Go written VM > :warning: Unlike the x86/amd64 VM compiled by Sointu, the Go written VM
> bytecode interpreter uses a software stack. Thus, unlike x87 FPU stack, it is > bytecode interpreter uses a software stack. Thus, unlike x87 FPU stack, it is
@ -78,9 +78,9 @@ interpreter written in Go.
### Compiler ### Compiler
The command line interface to it is [sointu-compile](cmd/sointu-compile) and the The command line interface to it is [sointu-compile](cmd/sointu-compile/main.go)
actual code resides in the [compiler](vm/compiler/) package, which is an ordinary and the actual code resides in the [compiler](vm/compiler/) package, which is an
[go](https://golang.org/) package with no other tool dependencies. ordinary [go](https://golang.org/) package with no other tool dependencies.
Running the compiler: Running the compiler:
@ -122,21 +122,21 @@ the same way when you would link them in an intro) requires:
obtained using Visual Studio 2019, gcc&make on linux, MinGW&mingw32-make, and obtained using Visual Studio 2019, gcc&make on linux, MinGW&mingw32-make, and
ninja&AppleClang. ninja&AppleClang.
For example, using MinGW: For example, using [ninja](https://ninja-build.org/):
``` ```
mkdir build mkdir build
cd build cd build
cmake .. -G"MinGW Makefiles" cmake .. -GNinja
mingw32-make ninja
mingw32-make test ninja test
``` ```
Note that this builds 64-bit binaries on 64-bit Windows. To build 32-bit Note that this builds 64-bit binaries on 64-bit Windows. To build 32-bit
binaries on 64-bit Windows, replace in above: binaries on 64-bit Windows, replace in above:
``` ```
cmake .. -DCMAKE_C_FLAGS="-m32" -DCMAKE_ASM_NASM_OBJECT_FORMAT="win32" -G"MinGW Makefiles" cmake .. -DCMAKE_C_FLAGS="-m32" -DCMAKE_ASM_NASM_OBJECT_FORMAT="win32" -GNinja
``` ```
Another example: on Visual Studio 2019 Community, just open the folder, choose Another example: on Visual Studio 2019 Community, just open the folder, choose
@ -312,7 +312,7 @@ New features since fork
sane than the low-level library API, offering more Go-like experience. sane than the low-level library API, offering more Go-like experience.
- **A bytecode interpreter written in pure go**. It's slightly slower than the - **A bytecode interpreter written in pure go**. It's slightly slower than the
hand-written assembly code by sointu compiler, but with this, the tracker is hand-written assembly code by sointu compiler, but with this, the tracker is
ultraportable. ultraportable and does not need cgo calls.
Future goals Future goals
------------ ------------