-
-
Notifications
You must be signed in to change notification settings - Fork 306
Description
🔧 Feature request 🔧
First of all - I love Alda and I just can't express how great this project is. I would like to thank the creators and everyone involved.
I just just would like to point out a minor documentation issue. I've found myself that running Alda requires studying the structure of this program, some aspects of this may be confusing, especially for a Raspberry Pi user who is unfamiliar with Kotlin and Go.
Description
I think that it may be useful to put simple build instructions in main readme.md file. It would be useful for people who use things like Raspberry Pi or maybe BSD systems.
Examples
-
Install OpenJDK, download Go for your system and install it.
-
Download and unzip Alda release or clone repository.
-
Compile player:
cd alda-release-X.X.X/player
./bin/run
Player binary is located in alda-release-X.X.X/player/target/X.X.X-/
4. Compile Alda client:
cd alda-release-X.X.X/client
go generate
go build
Client binary will be in alda-release-X.X.X/client
Motivation
There are musicians out there who are not familiar with Kotlin or Go but would be happy to test Alda.
Alternatives
Instructions are already in player/readme.md and client/readme.md so maybe it is just enough to link these files in main readme.md