jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update config.nims search path in docs (#9388)

Browse source 
Related: https://github.com/nim-lang/Nim/pull/8682

Also mention the "nim help" command to list all available tasks.
This commit is contained in:
Kaushal Modi 2018-10-16 18:17:10 -04:00 • committed by Andreas Rumpf
commit 3e9f506923
1 changed files with 20 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

23
doc/nims.rst
View file

@ -6,9 +6,25 @@ Strictly speaking, ``NimScript`` is the subset of Nim that can be evaluated
by Nim's builtin virtual machine (VM). This VM is used for Nim's compiletime by Nim's builtin virtual machine (VM). This VM is used for Nim's compiletime
function evaluation features. function evaluation features.
You can use a ``<myproject>.nims`` file that simply contains Nim code The ``nim`` executable processes the ``.nims`` configuration files in
controlling the compilation process. For a directory wide the following directories (in this order; later files overwrite
configuration, use ``config.nims`` instead of ``<myproject>.nims``. previous settings):
1) If environment variable ``XDG_CONFIG_HOME`` is defined,
``$XDG_CONFIG_HOME/nim/config.nims`` or
``~/.config/nim/config.nims`` (POSIX) or
``%APPDATA%/nim/config.nims`` (Windows). This file can be skipped
with the ``--skipUserCfg`` command line option.
2) ``$parentDir/config.nims`` where ``$parentDir`` stands for any
parent directory of the project file's path. These files can be
skipped with the ``--skipParentCfg`` command line option.
3) ``$projectDir/config.nims`` where ``$projectDir`` stands for the
project's path. This file can be skipped with the ``--skipProjCfg``
command line option.
4) A project can also have a project specific configuration file named
``$project.nims`` that resides in the same directory as
``$project.nim``. This file can be skipped with the same
``--skipProjCfg`` command line option.
The VM cannot deal with ``importc`` because the FFI is not The VM cannot deal with ``importc`` because the FFI is not
available. So the stdlib modules using ``importc`` cannot be used with available. So the stdlib modules using ``importc`` cannot be used with
@ -74,6 +90,7 @@ In fact, as a convention the following tasks should be available:
========= =================================================== ========= ===================================================
Task Description Task Description
========= =================================================== ========= ===================================================
``help`` List all the available NimScript tasks along with their docstrings.
``build`` Build the project with the required ``build`` Build the project with the required
backend (``c``, ``cpp`` or ``js``). backend (``c``, ``cpp`` or ``js``).
``tests`` Runs the tests belonging to the project. ``tests`` Runs the tests belonging to the project.