diff options
Diffstat (limited to 'doc/steps.txt')
| -rw-r--r-- | doc/steps.txt | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/doc/steps.txt b/doc/steps.txt new file mode 100644 index 000000000..89339377b --- /dev/null +++ b/doc/steps.txt @@ -0,0 +1,24 @@ +============================== +First steps after installation +============================== + +This document explains how to *use* the Nimrod compiler. +Open your favourite text editor and type (or download it +`here <download/code/hallo.nim>`_): + +.. code-block:: nimrod + :file: ../tests/hallo.nim + +Save this file as ``hallo.nim`` somewhere (I refer to the location as +``$yourloc``). Now open a console and call the Nimrod compiler:: + + nimrod compile --run $yourloc/hallo + +The ``--run`` switch tells Nimrod that it should run the generated +executable after successful compilation. If things don't work, +check if Nimrod's ``bin`` directory is in your path environment +variable. On Windows the directory ``dist\llvm-gcc4.2\bin`` may +also be required in your path. + +Note that Nimrod produced a standalone native executable in +``$yourloc`` that you can run without the Nimrod compiler. |