summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorJuan Carlos <juancarlospaco@gmail.com>2020-09-21 07:37:14 -0300
committerGitHub <noreply@github.com>2020-09-21 12:37:14 +0200
commitdb9ab2a4c00bc650a8526115d659b57dcd38c39b (patch)
tree59a4605ac15dca4f96dc04a5d6f79ccc0965ca52
parentc2434d939e193c066fad1eaefcba486dc0af6087 (diff)
downloadNim-db9ab2a4c00bc650a8526115d659b57dcd38c39b.tar.gz
Documentation prelude (#15377)
-rw-r--r--doc/prelude.rst29
1 files changed, 29 insertions, 0 deletions
diff --git a/doc/prelude.rst b/doc/prelude.rst
new file mode 100644
index 000000000..47fa70b70
--- /dev/null
+++ b/doc/prelude.rst
@@ -0,0 +1,29 @@
+Prelude
+=======
+
+This is an include file that simply imports common modules for your convenience:
+
+.. code-block:: nim
+  include prelude
+
+Same as:
+
+.. code-block:: nim
+  import os, strutils, times, parseutils, parseopt, hashes, tables, sets
+
+
+Examples
+========
+
+Get the basic most common imports ready to start coding using ``prelude``:
+
+.. code-block:: nim
+  include prelude
+
+  echo now()
+  echo getCurrentDir()
+  echo "Hello $1".format("World")
+
+
+See also:
+- `Sugar <sugar.html>`_