Document deployment

extra/tools/deploy/deploy-docs.factor

@@ -2,16 +2,20 @@ USING: help.markup help.syntax words alien.c-types assocs
 kernel ;
 IN: tools.deploy
 
-ARTICLE: "tools.deploy" "Stand-alone image deployment"
+ARTICLE: "tools.deploy" "Application deployment"
-"The stand-alone image deployment tool takes a vocabulary and generates an image, which when passed to the VM, runs the vocabulary's " { $link POSTPONE: MAIN: } " hook."
+"The stand-alone application deployment tool compiles a vocabulary down to a native executable which runs the vocabulary's " { $link POSTPONE: MAIN: } " hook. Deployed executables do not depend on Factor being installed, and do not expose any source code, and thus are suitable for delivering commercial end-user applications."
 $nl
 "For example, we can deploy the " { $vocab-link "hello-world" } " demo which comes with Factor:"
-{ $code "\"hello-world\" deploy" }
+{ $code "\"hello-ui\" deploy" }
-"This generates an image file named " { $snippet "hello-world.image" } ". Now we can start this image from the operating system's command line (see " { $link "runtime-cli-args" } "):"
+"On Mac OS X, this yields a program named " { $snippet "Hello world.app" } ". On Windows, it yields a directory named " { $snippet "Hello world" } " containing a program named " { $snippet "hello-ui.exe" } ". In both cases, running the program displays a window with a message."
-{ $code "./factor -i=hello-world.image" "Hello world" }
+$nl
-
+"The deployment tool works by bootstrapping a fresh image, loading the vocabulary into this image, then applying various heuristics to strip the image down to minimal size."
-"Once the necessary deployment flags have been set, a deployment image can be generated:"
+$nl
-{ $subsection deploy } ;
+"You must explicitly specify major subsystems which are required, as well as the level of reflection support needed. This is done by modifying the deployment configuration prior to deployment."
+{ $subsection "prepare-deploy" }
+"Once the necessary deployment flags have been set, the application can be deployed:"
+{ $subsection deploy }
+{ $see-also "ui.tools.deploy" } ;
 
 ABOUT: "tools.deploy"
 

extra/ui/tools/deploy/deploy-docs.factor

@@ -0,0 +1,14 @@
+USING: help.markup help.syntax ui.tools.deploy ;
+
+HELP: deploy-tool
+{ $values { "vocab" "a vocabulary specifier" } }
+{ $description "Opens the graphical deployment tool for the specified vocabulary." }
+{ $examples { $code "\"tetris\" deploy-tool" } } ;
+
+ARTICLE: "ui.tools.deploy" "Application deployment UI tool"
+"The application deployment UI tool provides a graphical front-end to deployment configuration. Using the tool, you can set deployment options graphically."
+$nl
+"To start the tool, pass a vocabulary name to a word:"
+{ $subsection deploy-tool }
+"Alternatively, right-click on a vocabulary presentation in the UI and choose " { $strong "Deploy tool" } " from the resulting popup menu."
+{ $see-also "tools.deploy" } ;

extra/ui/tools/tools-docs.factor

@@ -130,12 +130,14 @@ $nl
 { $subsection "ui-presentations" }
 { $subsection "ui-completion" }
 { $heading "Tools" }
-"All development tools are integrated into a single-window " { $emphasis "workspace" } "."
+"A single-window " { $emphasis "workspace" } " contains the most frequently-used tools:"
 { $subsection "ui-listener" }
 { $subsection "ui-browser" }
 { $subsection "ui-inspector" }
 { $subsection "ui-walker" }
 { $subsection "ui-profiler" }
+"Additional tools:"
+{ $subsection "ui.tools.deploy" }
 "Platform-specific features:"
 { $subsection "ui-cocoa" } ;