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

Updated readme.

Browse source
This commit is contained in:
Dominik Picheta 2012-12-06 19:46:24 +00:00
commit a16e6bd22a
2 changed files with 122 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

61
readme.md Normal file
View file

@ -0,0 +1,61 @@
# 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 however included with this repository under
the build directory.
Pre-compiled snapshots of the compiler are also available on
[Nimbuild](http://build.nimrod-code.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
* unzip
* 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
$ unzip build/csources.zip
$ ./build.sh
$ bin/nimrod c koch
$ ./koch boot -d:release
```
The install script (``install.sh``) 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](http://forum.nimrod-code.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.
## License
The compiler is licensed under the GPLv2 license, the standard library is
licensed under the LGPL license with a linking exception so that you can link
to it statically. 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.
Copyright (c) 2004-2012 Andreas Rumpf.
All rights reserved.

70
readme.txt
View file

@ -1,21 +1,61 @@
=========================================================== # Nimrod Compiler
Nimrod Compiler This repo contains the Nimrod compiler, Nimrod's stdlib, tools and documentation.
===========================================================
This is the **Nimrod Compiler**. Nimrod is a new statically typed, imperative ## Compiling
programming language, that supports procedural, functional, object oriented and Compiling the Nimrod compiler is quite straightforward. Because
generic programming styles while remaining simple and efficient. A special the Nimrod compiler itself is written in the Nimrod programming language
feature that Nimrod inherited from Lisp is that Nimrod's abstract syntax tree the C source of an older version of the compiler are needed to bootstrap the
(AST) is part of the specification - this allows a powerful macro system which latest version. The C sources are however included with this repository under
can be used to create domain specific languages. the build directory.
*Nimrod* is a compiled, garbage-collected systems programming language Pre-compiled snapshots of the compiler are also available on
which has an excellent productivity/performance ratio. Nimrod's design [Nimbuild](http://build.nimrod-code.org/). Your platform however may not currently
focuses on efficiency, expressiveness, elegance (in the order of be built for.
priority).
See the file ``install.txt`` for installation instructions. See the file The compiler currently supports the following platform and architecture combinations:
``doc/intern.txt`` for the internal documentation for developers.
* 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
* unzip
* 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
$ unzip build/csources.zip
$ ./build.sh
$ bin/nimrod c koch
$ ./koch boot -d:release
```
The install script (``install.sh``) 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](http://forum.nimrod-code.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.
## License
The compiler is licensed under the GPLv2 license, the standard library is
licensed under the LGPL license with a linking exception so that you can link
to it statically. 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.
Copyright (c) 2004-2012 Andreas Rumpf. Copyright (c) 2004-2012 Andreas Rumpf.
All rights reserved. All rights reserved.