This repository contains the Nim compiler, Nim's stdlib, tools and documentation. For more information about Nim, including downloads and documentation for the latest release, check out Nim's website.
- The forum - the best place to ask questions and to discuss Nim.
- #nim IRC Channel (Freenode) - a place to discuss Nim in real-time. Also where most development decisions get made.
- Gitter - an additional place to discuss Nim in real-time. There is a bridge between Gitter and the IRC channel.
- Telegram - an additional place to discuss Nim in real-time. There is the official Telegram channel.
- Stack Overflow - a popular Q/A site for programming related topics that includes posts about Nim.
- Github Wiki - Misc user-contributed content.
The compiler currently officially 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 greater) - x86, x86_64 and ppc64
More platforms are supported, however they are not tested regularly and they may not be as stable as the above-listed platforms.
Compiling the Nim compiler is quite straightforward if you follow these steps:
First, the C source of an older version of the Nim compiler is needed to
bootstrap the latest version because the Nim compiler itself is written in the
Nim programming language. Those C sources are available within the
Next, to build from source you will need:
- A C compiler such as
gcc3.x/later or an alternative such as
Intel C++. It is recommended to use
gcc3.x or later.
wgetto download the needed source repositories.
build-essentialpackage when using
gccon Ubuntu (and likely other distros as well).
Then, if you are on a *nix system or Windows, the following steps should compile
Nim from source using
git and the
koch build tool.
Note: The following commands are for the development version of the compiler. For most users, installing the latest stable version is enough. Check out the installation instructions on the website to do so: https://nim-lang.org/install.html.
# step 1: git clone https://github.com/nim-lang/Nim.git cd Nim # step 2 (posix) clones `csources.git`, bootstraps Nim compiler and compiles tools sh build_all.sh # step 2 (windows) git clone --depth 1 https://github.com/nim-lang/csources.git cd csources # requires `gcc` in your PATH, see also https://nim-lang.org/install_windows.html build.bat # x86 Windows build64.bat # x86_64 Windows cd .. bin\nim c koch koch boot -d:release koch tools # Compile Nimble and other tools # end of step 2 (windows)
Finally, once you have finished the build steps (on Windows, Mac or Linux) you
should add the
bin directory to your PATH.
koch is the build tool used to build various parts of Nim and to generate
documentation and the website, among other things. The
koch tool can also
be used to run the Nim test suite.
Assuming that you added Nim's
bin directory to your PATH, you may execute
the tests using
./koch tests. The tests take a while to run, but you
can run a subset of tests by specifying a category (for example
./koch tests cat async).
For more information on the
koch build tool please see the documentation
within the doc/koch.rst file.
nimble is Nim's package manager. To learn more about it, see the
This project exists thanks to all the people who contribute. Read on to find out how to contribute.
We welcome all contributions to Nim regardless of how small or large they are. Everything from spelling fixes to new modules to be included in the standard library are welcomed and appreciated. Before you start contributing, you should familiarize yourself with the following repository structure:
build/- these directories are empty, but are used when Nim is built.
compiler/- the compiler source code. Also includes nimfix, and plugins within
nimsuggest- the nimsuggest tool that previously lived in the
config/- the configuration for the compiler and documentation generator.
doc/- the documentation files in reStructuredText format.
lib/- the standard library, including:
pure/- modules in the standard library written in pure Nim.
impure/- modules in the standard library written in pure Nim with dependencies written in other languages.
wrappers/- modules which wrap dependencies written in other languages.
tests/- contains categorized tests for the compiler and standard library.
tools/- the tools including
nimweb(mostly invoked via
web/- the Nim website.
koch.nim- tool used to bootstrap Nim, generate C sources, build the website, and generate the documentation.
If you are not familiar with making a pull request using GitHub and/or git, please read this guide.
Ideally you should make sure that all tests pass before submitting a pull request.
However, if you are short on time, you can just run the tests specific to your
changes by only running the corresponding categories of tests. Travis CI verifies
that all tests pass before allowing the pull request to be accepted, so only
running specific tests should be harmless.
Integration tests should go in
You can also help with the development of Nim by making donations. Donations can be made using:
Thank you to all our backers! [Become a backer]
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [Become a sponsor]
You can also see a list of all our sponsors/backers from various payment services on the sponsors page of our website.
The compiler and the standard library are licensed under the MIT license, except for some modules which explicitly state otherwise. As a result you may use any compatible license (essentially any license) for your own programs developed with Nim. You are explicitly permitted to develop commercial applications using Nim.
Please read the copying.txt file for more details.
Copyright © 2006-2018 Andreas Rumpf, all rights reserved.