Skip to content
This repository has been archived by the owner on Jul 11, 2020. It is now read-only.

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
Signed-off-by: Angus Freudenberg <freudenberg.angus@gmail.com>
  • Loading branch information
afreuden committed Apr 15, 2018
1 parent 4b35638 commit 34e4493
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# android-sync
A command-line utility to synchronise iTunes music and other data between macOS and Android
A shell script to synchronise iTunes music and other data between macOS and Android

## Description
This simple shell script allows a user with a macOS computer to synchronise their iTunes library and playlists to an Android device. It is able to track changes to your lirbary and playlists such as additions and deletions.
This simple shell script allows a user with a macOS computer to synchronise their iTunes library and playlists to an Android device. It is able to track changes to your library and playlists such as additions and deletions.

## Dependencies
Android Debug Bridge <br />
Expand All @@ -22,11 +22,13 @@ scala-library.jar
- Double clicking android-sync in Finder (or create an alias and place on your desktop)

## Current Limitations
- The storage path is fixed to an external mounted device in the /storage directory. As such, this will only work with Android 6.0+<br />
- adb-sync cannot detect music files that have been updated with lyrics<br />
- There is currently no way to filter your library, it will synchronise every song you have in iTunes<br />
- There are no options to filter what playlists to synchronise as itunesexport.jar exports every playlist <br />
- This has not been tested on an unrooted Android device so I cannot comment on whether this script will work
- By design, this script requires USB debugging enabled under Developer Options in Android Settings. There is no way around this.
- The storage path is fixed to an external mounted device in the `/storage` directory. As such, this will only work on devices with Android 6.0 and higher.<br />
- `adb-sync.py` cannot detect music files that have been updated with lyrics as this does not change the checksum of the files.<br />
- There is currently no way to filter the music library, it will synchronise every song have in iTunes.<br />
- At this stage, there is not support for playlist filtering, however `itunesexport.jar` does support it and may be implemented at a later date.<br />
- This has not been tested on an unrooted Android device so I cannot comment on whether this script will work. However, there is no reason why it shouldn't.
- There is no implemented function that checks if there is enough free space on an SD card, so they're may be undocumented issues if a library larger than the external storage is transferred over.

## Credits
This utility uses the following modules: <br />
Expand Down

0 comments on commit 34e4493

Please sign in to comment.