readme

nbonamy · Dec 13, 2023 · a76ac29 · a76ac29
1 parent e2ab88f
commit a76ac29
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -1,16 +1,27 @@
 # trax
 
-A new Flutter project.
+macOS Music management application written in Flutter.
+
+- Apple Music like UI
+- Browse local music files
+- Import new files into libraruy (MP3, FLAC, M4A)
+- Edit audio tags (including artwork and lyrics)
+- Audio format conversion
+- Local audio playback
 
-## Getting Started
 
-This project is a starting point for a Flutter application.
+<img src="doc/home.jpg" height=256>
+<img src="doc/album.jpg" height=256>
+
+## Getting Started
 
-A few resources to get you started if this is your first Flutter project:
+```
+flutter pub get
+flutter run macos
+```
 
-- [Lab: Write your first Flutter app](https://docs.flutter.dev/get-started/codelab)
-- [Cookbook: Useful Flutter samples](https://docs.flutter.dev/cookbook)
+You can deploy to your `Applications` folder using
 
-For help getting started with Flutter development, view the
-[online documentation](https://docs.flutter.dev/), which offers tutorials,
-samples, guidance on mobile development, and a full API reference.
+```
+make deploy
+```
diff --git a/doc/album.jpg b/doc/album.jpg
diff --git a/doc/home.jpg b/doc/home.jpg