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 43d1181c04 year 2014		2014-02-02 00:02:39 +01:00
compiler	only 1 argument allowed for command expressions	2014-02-02 00:00:56 +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	documented new symbol binding rules for templates	2014-02-01 13:39:40 +01:00
examples	Add two CGI example and basic Python CGI server.	2013-12-18 18:19:32 +01:00
icons	Removes executable bit for text files.	2013-03-16 23:53:07 +01:00
lib	case consistency for dynlib.nim	2014-02-02 00:01:33 +01:00
tests	Merge branch 'devel' of https://github.com/Araq/Nimrod into devel	2014-01-23 12:22:49 +01:00
tinyc	Correct the spelling of the word 'implicitly'	2013-12-23 04:29:50 +02:00
tools	Merge branch 'pr_oniondocs' into pr_oniondocs_devel	2014-01-25 16:24:39 +01:00
web	Merge branch 'pr_oniondocs' into pr_oniondocs_devel	2014-01-25 16:24:39 +01:00
.gitignore	Removes generated .dot file uploaded by mistake.	2013-12-30 17:58:05 +01:00
contributors.txt	Removes executable bit for text files.	2013-03-16 23:53:07 +01:00
copying.txt	year 2014	2014-02-02 00:02:08 +01:00
install.txt	Add info about twitter and bootstrapping from github to website.	2014-01-12 20:13:26 +00:00
koch.nim	next steps for closure iterators	2014-01-22 17:32:38 +01:00
koch.nimrod.cfg	Fixes bootstrapping.	2012-09-03 19:44:25 +01:00
readme.md	year 2014	2014-02-02 00:02:08 +01:00
readme.txt	year 2014	2014-02-02 00:02:39 +01:00
start.bat	Removes executable bit for text files.	2013-03-16 23:53:07 +01:00
todo.txt	closure iterators work	2014-01-23 08:47:22 +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.