Merge: Added contributing guidelines and link from readme

[nit.git] / share / man / nit.md

diff --git a/share/man/nit.md b/share/man/nit.md
index 6fb1202..fcdec6c 100644 (file)
--- a/share/man/nit.md
+++ b/share/man/nit.md
@@ -6,6 +6,8 @@ nit - interprets and debugs Nit programs.
 
 nit [*options*] FILE [ARG]...
 
+nit [*options*] - [ARG]...
+
 nit [*options*] -e COMMAND [ARG]...
 
 # DESCRIPTION
@@ -16,6 +18,9 @@ It takes the main module of a program as the first argument then the options and
     $ nit examples/hello_world.nit
     hello world
 
+If `-` is used instead of a module, then the program is read from the standard input.
+The whole program is read before its interpretation starts.
+
 The Nit interpreter is usable and valid as a *shebang* interpreted directive.
 It is however recommended to use with `/usr/bin/env` because the location of the executable is not standardized.
 
@@ -84,24 +89,24 @@ This option helps the user to have a simplified but humanly readable overview of
 ## DEBUGGER OPTIONS
 
 ### `-d`
-Launches the target program with the debugger attached to it
+Launches the target program with the debugger attached to it.
 
 ### `-c`
-Launches the target program with the interpreter, such as when the program fails, the debugging prompt is summoned
+Launches the target program with the interpreter, such as when the program fails, the debugging prompt is summoned.
 
 ### `--socket`
-Launches the target program with raw output on the network via sockets
+Launches the target program with raw output on the network via sockets.
 
 ### `--websocket`
-Launches the target program with output on the network via websockets
+Launches the target program with output on the network via websockets.
 
 ### `--port`
-Sets the debug port (Defaults to 22125) - Must be contained between 0 and 65535
+Sets the debug port (Defaults to 22125) - Must be contained between 0 and 65535.
 
 ## OTHER OPTIONS
 
 ### `--vm`
-Run the virtual machine instead of the naive interpreter (experimental)
+Run the virtual machine instead of the naive interpreter (experimental).
 
 The virtual machine is currently under heavy development and, unless you are developing the vm, there is no reason to use this option yet.