summary refs log tree commit diff stats
diff options
context:
space:
mode:
authorAraq <rumpf_a@web.de>2016-09-28 23:39:43 +0200
committerAraq <rumpf_a@web.de>2016-09-28 23:39:56 +0200
commitae0e5604f4d643488b668a82f2eec90f2b2d4e4c (patch)
treee14cde6c1a044d78da333467327afed5d46dba68
parentb8325181d171e30bba0ac394ab095fd3f81584e3 (diff)
downloadNim-ae0e5604f4d643488b668a82f2eec90f2b2d4e4c.tar.gz
more documentation knows about the new install_tools.nims script
-rw-r--r--install.txt9
-rw-r--r--readme.md8
2 files changed, 17 insertions, 0 deletions
diff --git a/install.txt b/install.txt
index 67be2221b..833fbf0fb 100644
--- a/install.txt
+++ b/install.txt
@@ -30,6 +30,15 @@ There are also ``install.sh`` and ``deinstall.sh`` scripts for distributing
 the files over the UNIX hierarchy. However, updating your Nim installation
 is more cumbersome then.
 
+To complete the installation you should also build Nim's tools like
+``nimsuggest``, ``nimble`` or ``nimgrep`` via::
+
+  nim e install_tools.nims
+
+Note that these tools should also end up in your ``PATH`` so adding
+``$your_install_dir/bin/nim`` to your ``PATH`` is preferred over the symlink
+solution.
+
 
 Installation on the Macintosh
 -----------------------------
diff --git a/readme.md b/readme.md
index 204b51906..01061bfa2 100644
--- a/readme.md
+++ b/readme.md
@@ -51,6 +51,14 @@ instead of ``build.sh``.
 The ``koch`` tool is the Nim build tool, more ``koch`` related options are
 documented in [doc/koch.rst](doc/koch.rst).
 
+To complete the installation you should also build Nim's tools like
+``nimsuggest``, ``nimble`` or ``nimgrep``:
+
+```
+nim e install_tools.nims
+```
+
+
 ## Nimble
 [Nimble](https://github.com/nim-lang/nimble) is Nim's package manager. For the
 source based installations where you added Nim's ``bin`` directory to your PATH