documented nimfix

This commit is contained in:
Araq 2014-11-04 08:38:56 +01:00
commit 1f63d1c76e
7 changed files with 79 additions and 15 deletions

View file

@ -9,25 +9,25 @@ should be in your ``$PATH`` (most likely the case). Note that some few Linux
distributions do not ship with a GCC compiler preinstalled - then you have to
install it.
Install Nimrod by downloading the appropriate ``.zip`` file and extracting it
to a directory of your choice. The Nimrod Compiler will stay in this
Install Nim by downloading the appropriate ``.zip`` file and extracting it
to a directory of your choice. The Nim Compiler will stay in this
directory (unless you copy it somewhere else). The compiler does not need
write access to its directory, so copying the nimrod folder to ``/opt``
write access to its directory, so copying the nim folder to ``/opt``
works.
Then run the following command::
sh build.sh
Unlike other software, Nimrod does not distribute its files over the whole file
Unlike other software, Nim does not distribute its files over the whole file
hierarchy. This has the advantage that you can deinstall it by just deleting
its folder. The disadvantage is that you have to add it to your ``PATH``
manually. An alternative is to create a symbolic link in ``/usr/bin``::
[sudo] ln -s $your_install_dir/bin/nimrod /usr/bin/nimrod
[sudo] ln -s $your_install_dir/bin/nim /usr/bin/nim
There are also ``install.sh`` and ``deinstall.sh`` scripts for distributing
the files over the UNIX hierarchy. However, updating your Nimrod installation
the files over the UNIX hierarchy. However, updating your Nim installation
is more cumbersome then.
@ -43,9 +43,9 @@ You need to install Apple's developer's tools for the GNU Compiler Collection.
Installation on Windows
-----------------------
Install Nimrod by downloading and running the ``nimrod_$version.exe`` file.
Install Nim by downloading and running the ``nim_$version.exe`` file.
As default, the ``GCC`` compiler is used that is bundled with this installer.
You can change the configuration file ``config/nimrod.cfg`` to use
You can change the configuration file ``config/nim.cfg`` to use
another C compiler or change the path to GCC.
Currently, the following C compilers are supported under Windows:
@ -64,5 +64,5 @@ However, most testing is done with GCC.
Bootstrapping from Github
-------------------------
Take a look at the readme file on github `here <https://github.com/Araq/Nimrod#readme>`_
Take a look at the readme file on github `here <https://github.com/Araq/Nim#readme>`_
for instructions.