Skip to content

Commit afb4db8

Browse files
authored
Improve README formatting and clarity
Updated formatting and clarified instructions in README.
1 parent 178bfcc commit afb4db8

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,14 @@ This project uses Apache Ant and JDK 25 to compile, bundle, and package a Java a
55

66
## Common Requirements (All Systems)
77
Before running the build, ensure the following are installed and configured:
8-
- JDK 21 or 25: Must be installed. jpackage was introduced in JDK 14, but JDK 21+ is recommended for modern macOS/Linux support.
8+
- JDK 21 or 25: Must be installed. Although jpackage was introduced in JDK 14, JDK 21+ is recommended for modern macOS/Linux support.
99
- Apache Ant: Installed and available in your PATH.
10-
- JAVA_HOME: This environment variable must point to your JDK installation directory.
11-
- Check via: ant -version and java -version
10+
- `JAVA_HOME`: This environment variable must point to your JDK installation directory.
11+
- Check via: `ant -version` and `java -version`
1212
## macOS Setup
1313
To build the .dmg installer, your Mac needs the following:
1414
- Xcode Command Line Tools: Required for various build utilities.
15-
- Install via: xcode-select --install
15+
- Install via: `xcode-select --install`
1616
- Icon Asset: A file named icon.icns must be in the project root.
1717
- Note on Security: Since the app is not "Signed" with an Apple Developer Certificate, users may need to Right-Click > Open the app the first time to bypass the "Unidentified Developer" warning.
1818
## Ubuntu / Debian Setup
@@ -31,7 +31,7 @@ sudo apt install ant fakeroot dpkg-dev
3131
Ensure your project looks like this for the build.xml to find all resources:
3232

3333
```Plaintext
34-
MyAntApp/
34+
MyAppName/
3535
├── src/
3636
│ └── Main.java # Your source code
3737
├── icon.icns # Required for macOS DMG
@@ -93,7 +93,7 @@ git push origin v1.0.1
9393
- MyAntApp-Installer.dmg (for macOS)
9494
- MyAntApp-Linux.deb (for Ubuntu/Debian)
9595

96-
### Pro-Tip: Changing the Version Number
97-
When you're ready to bump the version, remember to update the version number in two places to keep everything in sync:
96+
### Changing the Version Number
97+
When ready to bump the version, remember to update the version number in **two** places to keep everything in sync:
9898
- The Git Tag (the v1.0.1 above).
99-
- The app.version property at the top of your build.xml. This ensures that when the user installs the app, the OS sees the correct version number in the "About" or "Get Info" screens.
99+
- The **app.version** property at the top of `build.xml`. This ensures that when the user installs the app, the OS sees the correct version number in the "About" or "Get Info" screens.

0 commit comments

Comments
 (0)