Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
SwadicalRag committed Jan 5, 2021
1 parent f734aa1 commit a74d0e1
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit a74d0e1

Please sign in to comment.