summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README39
1 files changed, 39 insertions, 0 deletions
diff --git a/README b/README
new file mode 100644
index 0000000..08b3d3b
--- /dev/null
+++ b/README
@@ -0,0 +1,39 @@
+ exe2app
+ -------
+
+exe2app.bash is a script to create a macOS Application bundle from a
+passed executable and icon file and other information.
+
+usage:
+
+exe2app.bash -x <executable path>
+ -i <icon path>
+ -o <created app path>
+ -v <version string>
+ -n <bundle identifier>
+ -c <creator code>
+
+<executable path>
+ The path to the executable to run as the app.
+
+<icon path>
+ The path to the image to use as an icon. Imagemagick convert is used
+ to generate the icons, so anything that can understand should work.
+
+<created app path>
+ The name of the generated app. The app will be named as the basename
+ of this path. ".app" will be added to this in the generated app so
+ shouldn't be supplied.
+
+<version string>
+ The version string to put in the plist file.
+
+<bundle identifier>
+ The bundle identifier. This string must be a uniform type identifier
+ (UTI) that contains only alphanumeric (A-Z,a-z,0-9), hyphen (-), and
+ period (.) characters. The string should also be in reverse-DNS format.
+ For example "com.yourdomain.appname".
+
+<creator code>
+ A 4-character string unique to the bundle. Quite how you know it's
+ unique I don't know.