Araq 0f53a06e7d make tests green again | 7 tahun lalu | |
---|---|---|
bin | 9 tahun lalu | |
build | 9 tahun lalu | |
ci | 7 tahun lalu | |
compiler | 7 tahun lalu | |
config | 7 tahun lalu | |
doc | 7 tahun lalu | |
examples | 7 tahun lalu | |
icons | 8 tahun lalu | |
lib | 7 tahun lalu | |
nimsuggest | 7 tahun lalu | |
tests | 7 tahun lalu | |
tinyc | 9 tahun lalu | |
tools | 7 tahun lalu | |
web | 7 tahun lalu | |
.gitignore | 7 tahun lalu | |
.gitlab-ci.yml | 8 tahun lalu | |
.travis.yml | 7 tahun lalu | |
appveyor.yml | 7 tahun lalu | |
changelog.md | 7 tahun lalu | |
compiler.nimble | 8 tahun lalu | |
copying.txt | 7 tahun lalu | |
install.txt | 8 tahun lalu | |
install_nimble.nims | 8 tahun lalu | |
install_tools.nims | 8 tahun lalu | |
koch.nim | 7 tahun lalu | |
koch.nim.cfg | 10 tahun lalu | |
readme.md | 7 tahun lalu | |
readme.txt | 9 tahun lalu | |
todo.txt | 7 tahun lalu |
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 compiler currently officially supports the following platform and architecture combinations:
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
nim-lang/csources
repository.
Next, to build from source you will need:
gcc
3.x/later or an alternative such as clang
,
Visual C++
or Intel C++
. It is recommended to use gcc
3.x or
later.git
or wget
to download the needed source repositories.build-essential
package when using gcc
on 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 gcc
, git
and the koch
build tool (in the place
of sh build.sh
you should substitute build.bat
on x86 Windows or
build64.bat
on x86_64 Windows):
git clone https://github.com/nim-lang/Nim.git
cd Nim
git clone --depth 1 https://github.com/nim-lang/csources.git
cd csources
sh build.sh
cd ../
bin/nim c koch
./koch boot -d:release
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 and it can be acquired from the
nim-lang/nimble
repository. Assuming that you added Nim's
bin
directory to your PATH, you may install Nimble from source by running
koch nimble
within the root of the cloned repository.
This project exists thanks to all the people who contribute. Read on to find out how to contribute.
We welcome everyone's contributions to Nim regardless of how small or how large they are. Anything from small spelling fixes to large modules intended to be included in the standard library are welcome and appreciated. Before you get started contributing, you should familiarize yourself with the repository structure:
bin/
, build/
- these directories are empty, but are used when Nim is built.compiler/
- the compiler source code. Also includes nimfix, and plugins within
compiler/nimfix
and compiler/plugins
respectively.nimsuggest
- the nimsuggest tool that previously lived in the nim-lang/nimsuggest
repository.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 niminst
and nimweb
(mostly invoked via
koch
).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.
If you're looking for ways to contribute, please look at our issue tracker.
There are always plenty of issues labelled Easy
; these should
be a good starting point for an initial contribution to Nim.
You can also help with the development of Nim by making donations. Donations can be made using:
If you have any questions feel free to submit a question on the Nim forum, or via IRC on the #nim channel.
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-2017 Andreas Rumpf, all rights reserved.