summary refs log tree commit diff stats
path: root/install.txt
diff options
context:
space:
mode:
authorAndreas Rumpf <rumpf_a@web.de>2009-05-08 16:36:06 +0200
committerAndreas Rumpf <rumpf_a@web.de>2009-05-08 16:36:06 +0200
commitdb4f617afcd095db087dcb52e3ea603cca111da7 (patch)
treeeeffcc8fb523171dc394c136acf9b8006ec4138f /install.txt
parent08bc9ac03c49db7bfcdee82f46aadf95a324e015 (diff)
downloadNim-db4f617afcd095db087dcb52e3ea603cca111da7.tar.gz
version 0.7.8
Diffstat (limited to 'install.txt')
-rw-r--r--install.txt133
1 files changed, 67 insertions, 66 deletions
diff --git a/install.txt b/install.txt
index 568c54282..a5aef4cbe 100644
--- a/install.txt
+++ b/install.txt
@@ -1,66 +1,67 @@
-Installation

-============

-

-

-Installation on Linux/UNIX

---------------------------

-

-Note:

-  A C compiler is required - knowledge of C is not!

-

-The GNU C Compiler is fully supported, other compilers may work. The C compiler

-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

-directory (unless you copy it somewhere else). The compiler does not need 

-write access to its directory anymore, so copying the nimrod folder to ``/opt`` 

-does work.

-

-Then run the following command::

-

-  sh build.sh

-

-Unlike other software, Nimrod 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

-

-

-Installation on the Macintosh

------------------------------

-

-Only MacOS X is supported.

-Since MacOS X is UNIX based too, it works like the installation on Linux. You

-need to install Apple's developer's tools for the GNU Compiler Collection

-though.

-

-

-Installation on Windows

------------------------

-

-Install Nimrod by downloading and running

-the ``nimrod_$version.exe`` file. As default, the ``LLVM-GCC`` 

-compiler is used that is bundled with this installer. You can change

-the configuration file to use another C compiler.

-

-Currently, the following C compilers are supported under Windows:

-

-- | Microsoft's Visual C++

-  | http://msdn.microsoft.com/visualc

-  | (You need the SDK too - but not the full one: Essential are only

-    the win32api header files and import libraries.)

-- | Gnu C Compiler (the mingw version; the cygwin version has not been tested!)

-  | http://www.mingw.org/download.shtml

-- | LLVM with GNU C/C++ frontend

-  | http://llvm.org/releases/download.html#2.2

-- | Digital Mars C++

-  | http://www.digitalmars.com/download/freecompiler.html

-

-For better compile times I recommend Digital Mars C++ -- it is easy to install

-and a small package.

-

+Installation
+============
+
+
+Installation on Linux/UNIX
+--------------------------
+
+Note:
+  A C compiler is required - knowledge of C is not!
+
+The GNU C Compiler is fully supported, other compilers may work. The C compiler
+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
+directory (unless you copy it somewhere else). The compiler does not need 
+write access to its directory, so copying the nimrod folder to ``/opt`` 
+does work.
+
+Then run the following command::
+
+  sh build.sh
+
+Unlike other software, Nimrod 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
+
+
+Installation on the Macintosh
+-----------------------------
+
+Only MacOS X is supported.
+Since MacOS X is UNIX based too, it works like the installation on Linux. You
+need to install Apple's developer's tools for the GNU Compiler Collection
+though.
+
+
+Installation on Windows
+-----------------------
+
+Install Nimrod by downloading and running
+the ``nimrod_$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 another C compiler 
+or change the path to GCC.**
+
+Currently, the following C compilers are supported under Windows:
+
+- | Microsoft's Visual C++
+  | http://msdn.microsoft.com/visualc
+  | (You need the SDK too - but not the full one: Only
+    the win32api header files and import libraries are essential.)
+- | Gnu C Compiler (the mingw version; the cygwin version has not been tested!)
+  | http://www.mingw.org/download.shtml
+- | LLVM with GNU C/C++ frontend
+  | http://llvm.org/releases/download.html#2.2
+- | Digital Mars C++
+  | http://www.digitalmars.com/download/freecompiler.html
+
+For better compile times I recommend Digital Mars C++ -- it is easy to install
+and a small package.
+