jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

readme.txt is not readme.md

Browse source
This commit is contained in:
Araq 2014-10-19 10:49:56 +02:00
commit 6f1b33e11c
2 changed files with 8 additions and 58 deletions
Download patch file Download diff file Expand all files Collapse all files

6
compiler/nimrod.ini
View file

@ -62,10 +62,8 @@ Files: "compiler/readme.txt"
Files: "compiler/nimrod.ini" Files: "compiler/nimrod.ini"
Files: "compiler/nimrod.cfg" Files: "compiler/nimrod.cfg"
Files: "compiler/*.nim" Files: "compiler/*.nim"
Files: "compiler/c2nim/*.nim" Files: "compiler/nimfix/*.nim"
Files: "compiler/c2nim/*.cfg" Files: "compiler/nimfix/*.cfg"
Files: "compiler/pas2nim/*.nim"
Files: "compiler/pas2nim/*.cfg"
[Lib] [Lib]

60
readme.txt
View file

@ -1,60 +1,12 @@
# Nimrod Compiler This package contains the Nimrod compiler, Nimrod's stdlib, tools and
This repo contains the Nimrod compiler, Nimrod's stdlib, tools and
documentation. documentation.
## Compiling Nimrod is a compiled, garbage-collected systems programming language which has
Compiling the Nimrod compiler is quite straightforward. Because an excellent productivity/performance ratio. Nimrod's design focuses on
the Nimrod compiler itself is written in the Nimrod programming language efficiency, expressiveness, elegance (in the order of priority).
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).
Pre-compiled snapshots of the compiler are also available on Read install.txt for instructions of how to build and install it.
[Nimbuild](http://build.nimrod-lang.org/). 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. 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, The compiler and the standard library are licensed under the MIT license,
except for some modules where the documentation suggests otherwise. This means except for some modules where the documentation suggests otherwise. This means
that you can use any license for your own programs developed with Nimrod, 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. Read copying.txt for more details.
Copyright (c) 2004-2014 Andreas Rumpf. Copyright (c) 2006-2014 Andreas Rumpf.
All rights reserved. All rights reserved.