Skip to content

Commit 6948261

Browse files
committed
Update README.md with new installation instructions
1 parent 9ecd0e5 commit 6948261

1 file changed

Lines changed: 42 additions & 14 deletions

File tree

README.md

Lines changed: 42 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,18 @@ that target this issue and none that are also useful for the average user.
1414

1515
## Installation
1616

17+
<details>
18+
<summary>Jar file with dependencies (prior to v1.7)</summary>
19+
1720
- Open your terminal and type in `java -version`.
18-
- If the command was not found or the version is below **18**,
19-
download and install Java for your operating system, e.g. from [here](https://www.azul.com/downloads/?package=jdk-fx#zulu).
21+
- If the command was not found or the version is below **18**,
22+
download and install Java for your operating system, e.g. from [here](https://www.azul.com/downloads/?package=jdk-fx#zulu).
2023
- Download the jar file of the [latest release](https://github.com/MaxiHuHe04/iTunes-Backup-Explorer/releases/latest) of iTunes Backup Explorer.
2124

2225
**Windows**
2326
- Simply double-click the downloaded file to start the program.
2427
- From the command line: `java -jar JARFILE.jar`.
25-
Replace `JARFILE.jar` with the name of the file you downloaded.
28+
Replace `JARFILE.jar` with the name of the file you downloaded.
2629

2730
**macOS**
2831
- `cd` to the download directory and type in `chmod +x JARFILE.jar`.
@@ -32,7 +35,7 @@ Replace `JARFILE.jar` with the name of the file you downloaded.
3235
**If you have permission issues**
3336

3437
When exporting data from the backup files, you might get `Operation not permitted`
35-
errors on your MacBook. To fix this, go to `System Settings > Privacy & Security > Full Disk Access` and add both `java` binary file and the `jar` file you downloaded.
38+
errors on your MacBook. To fix this, go to `System Settings > Privacy & Security > Full Disk Access` and add both the `java` binary file and the `jar` file you downloaded.
3639

3740
More detailed information can be checked [here](https://stackoverflow.com/questions/65469536/why-does-a-jar-file-have-no-permissions-to-read-from-disk-when-started-via-doubl/66762230#66762230).
3841

@@ -41,19 +44,28 @@ More detailed information can be checked [here](https://stackoverflow.com/questi
4144
- Depending on your specific system, you should be able to double-click the file to start the program.
4245
- If that does not work, use `java -jar JARFILE.jar` to run it.
4346

44-
## How to build
45-
### Native executables
46-
1. Install a current JDK and Maven
47-
2. Run `mvn clean package`
48-
3. You can find the built executable in `target/app-image` and an installer in `target/installer`
47+
</details>
4948

50-
### Jar with dependencies
51-
To get a jar file with dependencies for your system, use `mvn clean compile assembly:single`.
49+
Starting with version 1.7, the recommended way to install the program
50+
is using the installer for your operating system from the [latest release](https://github.com/MaxiHuHe04/iTunes-Backup-Explorer/releases/latest).
5251

53-
You can also build a fairly cross-platform jar file with dependencies for Windows, Linux and ARM macOS using the *most_platforms* profile: `mvn clean compile assembly:single -Pmost_platforms`
52+
### Windows
53+
Download and run the `_win_x64.msi` installer.
54+
By default, it installs the program just for your user
55+
and doesn't require administrator privileges.
56+
Then, simply double-click the shortcut on your desktop
57+
or use Windows search to launch it.
5458

55-
## How to run directly using Maven
56-
Use `mvn exec:exec`
59+
### macOS
60+
Files ending with `_mac_arm64.dmg` can be used to install the program on Apple silicon processors (M1, M2, ...)
61+
while `_mac_x64.dmg` images support Intel-based Macs.
62+
63+
You might have to go to `System Settings > Privacy & Security > Full Disk Access` and give the application
64+
full disk access to prevent `Operation not permitted` errors when trying to export files.
65+
66+
### Debian/Ubuntu
67+
Download the `_debian_x64.deb` file and install it using `sudo apt install ./path/to/package.deb`.
68+
The application is installed to `/opt/itunes-backup-explorer` and added to the desktop menu as an *archiving utility*.
5769

5870
## File Search
5971
In the "File Search" tab, you can search for files using case-insensitive SQLite LIKE syntax.
@@ -91,6 +103,22 @@ For me, this was a matter of course, but it was pointed out that I should clarif
91103
I do not collect any personal data. In fact, the program does not even use an internet connection at this time.
92104
If that should change at some point in the future, I will update this notice.
93105

106+
107+
## How to build
108+
### Native executables
109+
1. Install a current JDK and Maven
110+
2. Run `mvn clean package`
111+
3. You can find the built executable in `target/app-image` and an installer in `target/installer`
112+
113+
### Jar with dependencies
114+
To get a jar file with dependencies for your system, use `mvn clean compile assembly:single`.
115+
116+
You can also build a fairly cross-platform jar file with dependencies for Windows, Linux and ARM macOS using the *most_platforms* profile: `mvn clean compile assembly:single -Pmost_platforms`
117+
118+
119+
## How to run directly using Maven
120+
Use `mvn exec:exec`
121+
94122
## Credits
95123

96124
I started looking into this after I saw

0 commit comments

Comments
 (0)