]> gitweb.factorcode.org Git - factor.git/commitdiff
update vocabs and tools.deploy docs to mention icon files
authorJoe Groff <arcata@gmail.com>
Mon, 15 Feb 2010 22:18:26 +0000 (14:18 -0800)
committerJoe Groff <arcata@gmail.com>
Mon, 15 Feb 2010 22:18:26 +0000 (14:18 -0800)
basis/tools/deploy/deploy-docs.factor [changed mode: 0644->0755]
core/vocabs/loader/loader-docs.factor [changed mode: 0644->0755]

old mode 100644 (file)
new mode 100755 (executable)
index 2cbb286..a552bd0
@@ -11,7 +11,9 @@ ARTICLE: "prepare-deploy" "Preparing to deploy an application"
 } ;
 
 ARTICLE: "deploy-resources" "Deployed resource files"
-"To include additional files in your deployed application, specify their names in a vocabulary's " { $snippet "resources.txt" } " file. The " { $snippet "resources.txt" } " file contains one glob pattern per line. These patterns are expanded relative to the vocabulary directory; files outside of the vocabulary directory cannot be referenced. If a file inside the vocabulary directory matches any of these patterns, it will be included in deployed applications that reference the vocabulary. If a subdirectory matches, its contents will be included recursively." ;
+"To include additional files in your deployed application, specify their names in a vocabulary's " { $snippet "resources.txt" } " file. The " { $snippet "resources.txt" } " file contains one glob pattern per line. These patterns are expanded relative to the vocabulary directory; files outside of the vocabulary directory cannot be referenced. If a file inside the vocabulary directory matches any of these patterns, it will be included in deployed applications that reference the vocabulary. If a subdirectory matches, its contents will be included recursively."
+$nl
+"If the deployed vocabulary includes an icon file for the current platform (" { $snippet "icon.ico" } " on Windows, or " { $snippet "icon.icns" } " on MacOS X), it will be embedded in the deployed application as its GUI icon." ;
 
 ARTICLE: "tools.deploy.usage" "Deploy tool usage"
 "Once the necessary deployment flags have been set, the application can be deployed:"
old mode 100644 (file)
new mode 100755 (executable)
index 7db3cdd..ce4a319
@@ -52,6 +52,8 @@ $nl
     { { $snippet "foo/bar/summary.txt" } " - a one-line description." }
     { { $snippet "foo/bar/tags.txt" } " - a whitespace-separated list of tags which classify the vocabulary. Consult " { $link "vocab-tags" } " for a list of existing tags you can reuse." }
 }
+"An icon file representing the vocabulary can also be provided. A file named " { $snippet "icon.ico" } " will be used as the application icon when the application is deployed on Windows. A file named " { $snippet "icon.icns" } " will be used when the application is deployed on MacOS X."
+$nl
 "The " { $link POSTPONE: USE: } " and " { $link POSTPONE: USING: } " words load vocabularies which have not been loaded yet, as needed."
 $nl
 "Vocabularies can also be loaded at run time, without altering the vocabulary search path. This is done by calling a word which loads a vocabulary if it is not in the image, doing nothing if it is:"