diff options
author | Araq <rumpf_a@web.de> | 2014-10-19 10:49:56 +0200 |
---|---|---|
committer | Araq <rumpf_a@web.de> | 2014-10-19 10:49:56 +0200 |
commit | 6f1b33e11c03dfa7dfcbccaf9b7fe2265d4eca26 (patch) | |
tree | 2e40f616b15e029d1e4a5051e02c8864ed5abddd /readme.txt | |
parent | 32444e47a0532b7badf4af133165145e03d906a6 (diff) | |
download | Nim-6f1b33e11c03dfa7dfcbccaf9b7fe2265d4eca26.tar.gz |
readme.txt is not readme.md
Diffstat (limited to 'readme.txt')
-rw-r--r-- | readme.txt | 60 |
1 files changed, 6 insertions, 54 deletions
diff --git a/readme.txt b/readme.txt index 3f6aef05c..f9e5054fe 100644 --- a/readme.txt +++ b/readme.txt @@ -1,60 +1,12 @@ -# Nimrod Compiler -This repo contains the Nimrod compiler, Nimrod's stdlib, tools and +This package 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](http://github.com/nimrod-code/csources). +Nimrod is a compiled, garbage-collected systems programming language which has +an excellent productivity/performance ratio. Nimrod's design focuses on +efficiency, expressiveness, elegance (in the order of priority). -Pre-compiled snapshots of the compiler are also available on -[Nimbuild](http://build.nimrod-lang.org/). Your platform however may not -currently be built for. +Read install.txt for instructions of how to build and install it. -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. More ``koch`` related options are documented in -[doc/koch.txt](doc/koch.txt). - -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](http://forum.nimrod-lang.org/) is available if you have any -questions, and you can also get help in the IRC channel on -[Freenode](irc://irc.freenode.net/nimrod) in #nimrod. If you ask questions on -[StackOverflow use the nimrod -tag](http://stackoverflow.com/questions/tagged/nimrod). - -## 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, @@ -62,5 +14,5 @@ allowing you to create commercial applications. Read copying.txt for more details. -Copyright (c) 2004-2014 Andreas Rumpf. +Copyright (c) 2006-2014 Andreas Rumpf. All rights reserved. |