diff --git a/README.md b/README.md index e3fe9ed..bffb635 100644 --- a/README.md +++ b/README.md @@ -42,32 +42,43 @@ pip install pillow pngmeta ## Building for Distribution -### Mac OS (using py2app) +### Using build.py (Recommended) 1. First install the required build tools: ```bash - pip install py2app + pip install pyinstaller ``` -2. Build the application bundle: +2. Build the application for your platform: ```bash - python setup.py py2app + python build.py ``` -3. The resulting .app bundle will be in the `dist/` directory +3. The resulting executable will be in the `dist/` directory -### Windows (using PyInstaller) +### Manual PyInstaller Commands +#### Windows ```bash pyinstaller --name="PNG Metadata Editor" \ --windowed \ --onefile \ --icon=AppIcon.ico \ + --version-file version.txt \ png-meta-editor.py ``` -### Linux (using PyInstaller) +#### Mac OS +```bash +pyinstaller --name="PNG Metadata Editor" \ + --windowed \ + --onefile \ + --icon=AppIcon.icns \ + --version-file version.txt \ + png-meta-editor.py +``` +#### Linux ```bash pyinstaller --name="PNG Metadata Editor" \ --windowed \ @@ -75,6 +86,14 @@ pyinstaller --name="PNG Metadata Editor" \ png-meta-editor.py ``` +## Required Files + +For building, you'll need: +- `version.txt` (for version information) +- `AppIcon.ico` (Windows icon) +- `AppIcon.icns` (Mac icon) +- `requirements.txt` (for dependencies) + ## License This project is licensed under the MIT License - see [LICENSE](LICENSE) for details. @@ -82,7 +101,7 @@ This project is licensed under the MIT License - see [LICENSE](LICENSE) for deta ## Author Robert Tusa -[Your Contact Information] +robert@tusa.at ## Version History