share: add picnit manual
authorAlexis Laferrière <alexis.laf@xymus.net>
Sat, 17 Feb 2018 23:59:00 +0000 (18:59 -0500)
committerAlexis Laferrière <alexis.laf@xymus.net>
Sun, 18 Feb 2018 17:12:38 +0000 (12:12 -0500)
Signed-off-by: Alexis Laferrière <alexis.laf@xymus.net>

share/man/picnit.md [new file with mode: 0644]

diff --git a/share/man/picnit.md b/share/man/picnit.md
new file mode 100644 (file)
index 0000000..6b353d1
--- /dev/null
@@ -0,0 +1,55 @@
+# NAME
+
+picnit - Nit package manager
+
+# SYNOPSIS
+
+picnit [--help] [--verbose] <command> [<args>]
+
+# OPTIONS
+
+### `-h`, `--help`
+
+Show the help message.
+
+### `-v`, `--verbose`
+
+Print more information, may be useful for debugging.
+
+# COMMANDS
+
+### install
+
+Install a package by searching for its name or directly from a Git repository URL.
+
+       picnit install hello_picnit
+       picnit install https://gitlab.com/xymus/hello_picnit.git
+
+### list
+
+List installed packages.
+
+       picnit list
+
+### upgrade
+
+Upgrade a package.
+
+       picnit upgrade hello_picnit
+
+### uninstall
+
+Uninstall a package.
+
+       picnit uninstall hello_picnit
+
+### help
+
+Show general help message or the help for a command.
+
+       picnit help
+       picnit help install
+
+# SEE ALSO
+
+The Nit language documentation and the source code of its tools and libraries may be downloaded from <http://nitlanguage.org>