jyapayne/Nim

Fork 0

Nim (formerly known as "Nimrod") is a compiled, garbage-collected systems programming language which has an excellent productivity/performance ratio. Nim's design focuses on efficiency, expressiveness, elegance (in the order of priority). http://nim-lang.org/

Find a file

Araq 9145bcfbb6 new VM: some progress for the FFI support		2013-12-23 01:17:48 +01:00
compiler	new VM: some progress for the FFI support	2013-12-23 01:17:48 +01:00
config	Merge branch 'master' into vm2	2013-12-05 00:03:27 +01:00
devel	openarray/varargs split; breaks bootstrapping	2012-08-16 08:34:33 +02:00
doc	Merge branch 'master' into vm2	2013-12-13 15:58:03 +01:00
examples	Revert "removed windows". Refs #698 .	2013-12-09 18:28:11 +01:00
icons	Removes executable bit for text files.	2013-03-16 23:53:07 +01:00
lib	new VM: some progress for the FFI support	2013-12-23 01:17:48 +01:00
tests	Merge branch 'master' into vm2	2013-12-13 15:58:03 +01:00
tinyc	Removes executable bit for text files.	2013-03-16 23:53:07 +01:00
tools	new VM: some progress for the FFI support	2013-12-23 01:17:48 +01:00
web	Merge branch 'master' into vm2	2013-12-13 15:58:03 +01:00
.gitignore	Reimplement parseopt which parses arguments given as a sequence of strings, not single string.	2013-12-09 23:29:16 +01:00
contributors.txt	Removes executable bit for text files.	2013-03-16 23:53:07 +01:00
copying.txt	made some tests green; implemented 'from module import nil'	2013-05-19 23:17:16 +02:00
install.txt	Removed outdated bootstrapping info from install.txt	2013-08-23 23:14:27 +01:00
koch.nim	jump optimizer works	2013-10-29 16:47:40 +01:00
koch.nimrod.cfg	Fixes bootstrapping.	2012-09-03 19:44:25 +01:00
readme.md	Modified website links in readme.	2013-11-21 22:47:02 +00:00
readme.txt	Modified website links in readme.	2013-11-21 22:47:02 +00:00
start.bat	Removes executable bit for text files.	2013-03-16 23:53:07 +01:00
todo.txt	new VM: some progress for the FFI support	2013-12-23 01:17:48 +01:00

readme.md

Nimrod Compiler

This repo contains the Nimrod compiler, Nimrod's stdlib, tools and documentation.

Compiling

Compiling the Nimrod compiler is quite straightforward. Because the Nimrod compiler itself is written in the Nimrod programming language the C source of an older version of the compiler are needed to bootstrap the latest version. The C sources are available in a separate repo here.

Pre-compiled snapshots of the compiler are also available on Nimbuild. Your platform however may not currently be built for.

The compiler currently supports the following platform and architecture combinations:

Windows (Windows XP or greater) - x86 and x86_64
Linux (most, if not all, distributions) - x86, x86_64, ppc64 and armv6l
Mac OS X 10.04 or higher - x86, x86_64 and ppc64

In reality a lot more are supported, however they are not tested regularly.

To build from source you will need:

gcc 3.x or later recommended. Other alternatives which may work are: clang, Visual C++, Intel's C++ compiler
git or wget

If you are on a fairly modern *nix system, the following steps should work:

$ git clone git://github.com/Araq/Nimrod.git
$ cd Nimrod
$ git clone --depth 1 git://github.com/nimrod-code/csources
$ cd csources && ./build.sh
$ cd ..
$ bin/nimrod c koch
$ ./koch boot -d:release

koch install [dir] may then be used to install Nimrod, or you can simply add it to your PATH.

The above steps can be performed on Windows in a similar fashion, the build.bat and build64.bat (for x86_64 systems) are provided to be used instead of build.sh.

Getting help

A forum is available if you have any questions, and you can also get help in the IRC channel on Freenode in #nimrod. If you ask questions on StackOverflow use the nimrod tag.

License

The compiler and the standard library are licensed under the MIT license, except for some modules where the documentation suggests otherwise. This means that you can use any license for your own programs developed with Nimrod, allowing you to create commercial applications.

Read copying.txt for more details.