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

Commit 34e4493

Browse files
committed
update README.md
Signed-off-by: Angus Freudenberg <freudenberg.angus@gmail.com>
1 parent 4b35638 commit 34e4493

1 file changed

Lines changed: 9 additions & 7 deletions

File tree

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# android-sync
2-
A command-line utility to synchronise iTunes music and other data between macOS and Android
2+
A shell script to synchronise iTunes music and other data between macOS and Android
33

44
## Description
5-
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.
5+
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.
66

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

2424
## Current Limitations
25-
- 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 />
26-
- adb-sync cannot detect music files that have been updated with lyrics<br />
27-
- There is currently no way to filter your library, it will synchronise every song you have in iTunes<br />
28-
- There are no options to filter what playlists to synchronise as itunesexport.jar exports every playlist <br />
29-
- This has not been tested on an unrooted Android device so I cannot comment on whether this script will work
25+
- By design, this script requires USB debugging enabled under Developer Options in Android Settings. There is no way around this.
26+
- 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 />
27+
- `adb-sync.py` cannot detect music files that have been updated with lyrics as this does not change the checksum of the files.<br />
28+
- There is currently no way to filter the music library, it will synchronise every song have in iTunes.<br />
29+
- 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 />
30+
- 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.
31+
- 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.
3032

3133
## Credits
3234
This utility uses the following modules: <br />

0 commit comments

Comments
 (0)