Nimrod renamed to Nim
This commit is contained in:
parent
c95e47216f
commit
3ea6446900
30 changed files with 379 additions and 379 deletions
42
doc/koch.txt
42
doc/koch.txt
|
|
@ -1,8 +1,8 @@
|
|||
===============================
|
||||
Nimrod maintenance script
|
||||
Nim maintenance script
|
||||
===============================
|
||||
|
||||
:Version: |nimrodversion|
|
||||
:Version: |nimversion|
|
||||
|
||||
.. contents::
|
||||
|
||||
|
|
@ -15,10 +15,10 @@
|
|||
Introduction
|
||||
============
|
||||
|
||||
The `koch`:idx: program is Nimrod's maintenance script. It is a replacement
|
||||
The `koch`:idx: program is Nim's maintenance script. It is a replacement
|
||||
for make and shell scripting with the advantage that it is much more portable.
|
||||
The word *koch* means *cook* in German. ``koch`` is used mainly to build the
|
||||
Nimrod compiler, but it can also be used for other tasks. This document
|
||||
Nim compiler, but it can also be used for other tasks. This document
|
||||
describes the supported commands and their options.
|
||||
|
||||
|
||||
|
|
@ -40,21 +40,21 @@ options:
|
|||
option is not supported on Windows.
|
||||
-d:useGnuReadline
|
||||
Includes the `rdstdin module <rdstdin.html>`_ for `interactive
|
||||
mode <nimrodc.html#nimrod-interactive-mode>`_ (aka ``nimrod i``).
|
||||
mode <nimc.html#nim-interactive-mode>`_ (aka ``nim i``).
|
||||
This is not needed on Windows. On other platforms this may
|
||||
incorporate the GNU readline library.
|
||||
-d:nativeStacktrace
|
||||
Use native stack traces (only for Mac OS X or Linux).
|
||||
-d:noCaas
|
||||
Builds Nimrod without compiler as a service (CAAS) support. CAAS
|
||||
support is required for functionality like Nimrod's `idetool
|
||||
Builds Nim without compiler as a service (CAAS) support. CAAS
|
||||
support is required for functionality like Nim's `idetool
|
||||
<idetools.html>`_ command used to integrate the compiler with
|
||||
`external IDEs <https://github.com/Araq/Nimrod/wiki/Editor-Support>`_.
|
||||
`external IDEs <https://github.com/Araq/Nim/wiki/Editor-Support>`_.
|
||||
-d:avoidTimeMachine
|
||||
Only for Mac OS X, activating this switch will force excluding
|
||||
the generated ``nimcache`` directories from Time Machine backups.
|
||||
By default ``nimcache`` directories will be included in backups,
|
||||
and just for the Nimrod compiler itself it means backing up 20MB
|
||||
and just for the Nim compiler itself it means backing up 20MB
|
||||
of generated files each time you update the compiler. Using this
|
||||
option will make the compiler invoke the `tmutil
|
||||
<https://developer.apple.com/library/mac/documentation/Darwin/Reference/Manpages/man8/tmutil.8.html>`_
|
||||
|
|
@ -66,18 +66,18 @@ options:
|
|||
|
||||
$ find . -type d -name nimcache -exec tmutil isexcluded \{\} \;
|
||||
-d:useFFI
|
||||
Nimrod code can use the `foreign function interface (FFI)
|
||||
Nim code can use the `foreign function interface (FFI)
|
||||
<manual.html#foreign-function-interface>`_ at runtime, but macros
|
||||
are limited to pure Nimrod code at compilation time. Enabling
|
||||
this switch will allow macros to execute non-nimrod code at
|
||||
are limited to pure Nim code at compilation time. Enabling
|
||||
this switch will allow macros to execute non-nim code at
|
||||
compilation time (eg. open a file and write to it).
|
||||
--gc:refc|v2|markAndSweep|boehm|none
|
||||
Selects which garbage collection strategy to use for the compiler
|
||||
and generated code. See the `Nimrod's Garbage Collector <gc.html>`_
|
||||
and generated code. See the `Nim's Garbage Collector <gc.html>`_
|
||||
documentation for more information.
|
||||
|
||||
After compilation is finished you will hopefully end up with the nimrod
|
||||
compiler in the ``bin`` directory. You can add Nimrod's ``bin`` directory to
|
||||
After compilation is finished you will hopefully end up with the nim
|
||||
compiler in the ``bin`` directory. You can add Nim's ``bin`` directory to
|
||||
your ``$PATH`` or use the `install command`_ to place it where it will be
|
||||
found.
|
||||
|
||||
|
|
@ -101,7 +101,7 @@ The `inno`:idx: command builds the `Inno Setup installer for Windows
|
|||
install command
|
||||
---------------
|
||||
|
||||
The `install`:idx: command installs Nimrod to the specified directory, which
|
||||
The `install`:idx: command installs Nim to the specified directory, which
|
||||
is required as a parameter. For example, on Unix platforms you could run::
|
||||
|
||||
$ ./koch install /usr/local/bin
|
||||
|
|
@ -109,8 +109,8 @@ is required as a parameter. For example, on Unix platforms you could run::
|
|||
temp command
|
||||
------------
|
||||
|
||||
The temp command builds the Nimrod compiler but with a different final name
|
||||
(``nimrod_temp``), so it doesn't overwrite your normal compiler. You can use
|
||||
The temp command builds the Nim compiler but with a different final name
|
||||
(``nim_temp``), so it doesn't overwrite your normal compiler. You can use
|
||||
this command to test different options, the same you would issue for the `boot
|
||||
command`_.
|
||||
|
||||
|
|
@ -119,14 +119,14 @@ test command
|
|||
|
||||
The `test`:idx: command can also be invoked with the alias ``tests``. This
|
||||
command will compile and run ``tests/testament/tester.nim``, which is the main
|
||||
driver of Nimrod's test suite. You can pass options to the ``test`` command,
|
||||
driver of Nim's test suite. You can pass options to the ``test`` command,
|
||||
they will be forwarded to the tester. See its source code for available
|
||||
options.
|
||||
|
||||
update command
|
||||
--------------
|
||||
|
||||
The `update`:idx: command updates nimrod to the latest version from github.
|
||||
The `update`:idx: command updates nim to the latest version from github.
|
||||
For this command to work you need to have compiled ``koch`` itself with the
|
||||
``-d:withUpdate`` switch.
|
||||
|
||||
|
|
@ -136,7 +136,7 @@ web command
|
|||
The `web`:idx: command converts the documentation in the ``doc`` directory
|
||||
from rst to HTML. It also repeats the same operation but places the result in
|
||||
the ``web/upload`` which can be used to update the website at
|
||||
http://nimrod-lang.org.
|
||||
http://nim-lang.org.
|
||||
|
||||
zip command
|
||||
-----------
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue