From 6b007e88092f1d36a550a22f786b3a9caa9536f2 Mon Sep 17 00:00:00 2001 From: Eugen Minciu Date: Sun, 28 Dec 2014 21:49:04 +0200 Subject: [PATCH] Document the binDir and nimble build changes. --- developers.markdown | 3 +++ readme.markdown | 8 ++++++-- 2 files changed, 9 insertions(+), 2 deletions(-) diff --git a/developers.markdown b/developers.markdown index db66d70..bd29571 100644 --- a/developers.markdown +++ b/developers.markdown @@ -212,6 +212,9 @@ their own packages to it! Take a look at * ``srcDir`` - Specifies the directory which contains the .nim source files. **Default**: The directory in which the .nimble file resides; i.e. root dir of package. +* ``buildDir`` - Specifies the directory which contains the .nim source files. + **Default**: The directory in which the .nimble file resides; i.e. root dir of + package. * ``bin`` - A list of files which should be built separated by commas with no file extension required. This option turns your package into a *binary package*, nimble will build the files specified and install them appropriately. diff --git a/readme.markdown b/readme.markdown index 50619fd..33d17fa 100644 --- a/readme.markdown +++ b/readme.markdown @@ -158,8 +158,12 @@ Similar to the ``install`` command you can specify a version range, for example: ### nimble build The ``build`` command is mostly used by developers who want to test building -their ``.nimble`` package. The ``install`` command calls ``build`` implicitly, -so there is rarely any reason to use this command directly. +their ``.nimble`` package. This command will build the package in debug mode, +without installing anything. The ``install`` command will build the package +in release mode instead. + +If you are a developer willing to produce new Nimble packages please read the +[developers.markdown file](developers.markdown) for detailed information. ### nimble list