diff --git a/README.md b/README.md index d89afa7..f4829c7 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,17 @@ Coming soon! ### [04/01/2021] 0.0.1 - Proof of concept - Basic functionality implemented -## Nota bene +## Building -This is my first Dart/Flutter project, and I am still learning how the Flutter engine works. Though I can figure out how to write logic for a component, I may not know the best way to do it, and I certainly am not familiar with the best practices for Dart and Flutter. I am sorry in advance. +Building Steps: +1. Clone this repository somewhere +2. `flutter pub get` -> gets all packages +3. `flutter pub run build_runner build` -> build the generated files for json_serializable +4. `flutter build windows/macos/linux` +5. *sigh* just read this https://flutter.dev/desktop#distribution + +N.B. I have used a fixed version of flutter_desktop_audio which I do not plan on releasing publicly, because I do not wish to maintain that codebase. I will be replacing that module with my own FFI based audio playback library. Until then, if you want to build this yourself, shoot me a message and I can give you source access to my version of flutter_desktop_audio. + +## N.B. I am sorry in advance + +This is my first Dart/Flutter project, and I am still learning how the Flutter engine works. Though I can figure out how to write logic for a component, I may not know the best way to do it, and I certainly am not familiar with the best practices for Dart and Flutter. The more code I write, the more will learn, and the more my code quality will improve. I am sorry in advance.