alda icon indicating copy to clipboard operation
alda copied to clipboard

Add build instructions to main README.md (fixes #402)

Open ANONYMOUSZED-beep opened this issue 1 month ago • 1 comments

Summary Adds a "Building from Source" section to the main [README.md] to help users who need to compile Alda themselves, such as Raspberry Pi or BSD users.

Changes Added a "Building" link to the header navigation bar Added a new "Building from Source" section with: Clear requirements (Java 8+, Go 1.19+) Step-by-step build instructions for both player and client Cross-platform commands (Linux/macOS and Windows) Links to detailed READMEs in [client] and [player] directories

Motivation As noted in #402, musicians who are unfamiliar with Kotlin and Go may find it difficult to build Alda from source. This addition provides simple, accessible instructions directly in the main README, making it easier for users on unsupported platforms to get started.

ANONYMOUSZED-beep avatar Nov 26 '25 05:11 ANONYMOUSZED-beep

This PR addresses the documentation gap mentioned in #402. I've added clear, beginner-friendly build instructions to help Raspberry Pi and BSD users compile Alda from source. Let me know if any changes are needed!

ANONYMOUSZED-beep avatar Nov 26 '25 05:11 ANONYMOUSZED-beep