summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--docs/toc.json1
-rw-r--r--docs/tools.md1
-rw-r--r--docs/tools/compiler.md18
3 files changed, 20 insertions, 0 deletions
diff --git a/docs/toc.json b/docs/toc.json
index ded25ce97..cb3011d73 100644
--- a/docs/toc.json
+++ b/docs/toc.json
@@ -69,6 +69,7 @@
"formatter": "Formatter",
"repl": "Read-eval-print-loop",
"bundler": "Bundler",
+ "compiler": "Compiling executables",
"documentation_generator": "Documentation generator",
"dependency_inspector": "Dependency inspector",
"linter": "Linter"
diff --git a/docs/tools.md b/docs/tools.md
index 5945ee015..87a3c936b 100644
--- a/docs/tools.md
+++ b/docs/tools.md
@@ -4,6 +4,7 @@ Deno provides some built in tooling that is useful when working with JavaScript
and TypeScript:
- [bundler (`deno bundle`)](./tools/bundler.md)
+- [compiling executables (`deno compile`)](./tools/compiler.md)
- [dependency inspector (`deno info`)](./tools/dependency_inspector.md)
- [documentation generator (`deno doc`)](./tools/documentation_generator.md)
- [formatter (`deno fmt`)](./tools/formatter.md)
diff --git a/docs/tools/compiler.md b/docs/tools/compiler.md
new file mode 100644
index 000000000..34dbbdcc8
--- /dev/null
+++ b/docs/tools/compiler.md
@@ -0,0 +1,18 @@
+## Compiling Executables
+
+> Since the compile functionality is relatively new, the `--unstable` flag has
+> to be set in order for the command to work.
+
+`deno compile [SRC] [OUT]` will compile the script into a self contained
+executable.
+
+```
+> deno compile --unstable https://deno.land/std/http/file_server.ts
+```
+
+If you omit the `OUT` parameter, the name of the executable file will be
+inferred.
+
+### Cross Compilation
+
+Cross compiling binaries for different platforms is not currently possible.