510392bc60
Adds a badge showing the number of people helping this repo on CodeTriage. [](https://www.codetriage.com/nim-lang/nim) ## What is CodeTriage? CodeTriage is an Open Source app that is designed to make contributing to Open Source projects easier. It works by sending subscribers a few open issues in their inbox. If subscribers get busy, there is an algorithm that backs off issue load so they do not get overwhelmed [Read more about the CodeTriage project](https://www.codetriage.com/what). ## Why am I getting this PR? Your project was picked by the human, @schneems. They selected it from the projects submitted to https://www.codetriage.com and hand edited the PR. How did your project get added to [CodeTriage](https://www.codetriage.com/what)? Roughly 4 months ago, [@milan15](https://github.com/milan15) added this project to CodeTriage in order to start contributing. Since then, 4 people have subscribed to help this repo. ## What does adding a badge accomplish? Adding a badge invites people to help contribute to your project. It also lets developers know that others are invested in the longterm success and maintainability of the project. You can see an example of a CodeTriage badge on these popular OSS READMEs: - [](https://www.codetriage.com/rails/rails) https://github.com/rails/rails - [](https://www.codetriage.com/crystal-lang/crystal) https://github.com/crystal-lang/crystal ## Have a question or comment? While I am a bot, this PR was manually reviewed and monitored by a human - @schneems. My job is writing commit messages and handling PR logistics. If you have any questions, you can reply back to this PR and they will be answered by @schneems. If you do not want a badge right now, no worries, close the PR, you will not hear from me again. Thanks for making your project Open Source! Any feedback is greatly appreciated.
206 lines
11 KiB
Markdown
206 lines
11 KiB
Markdown
# <img src="https://raw.githubusercontent.com/nim-lang/assets/master/Art/logo-crown.png" height="28px"/> Nim [![Build Status][badge-nim-travisci]][nim-travisci]
|
|
|
|
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][nim-site].
|
|
|
|
## Community
|
|
[![Join the IRC chat][badge-nim-irc]][nim-irc]
|
|
[![Join the Gitter chat][badge-nim-gitter]][nim-gitter]
|
|
[![Get help][badge-nim-forum-gethelp]][nim-forum]
|
|
[![View Nim posts on Stack Overflow][badge-nim-stackoverflow]][nim-stackoverflow-newest]
|
|
[![Follow @nim_lang on Twitter][badge-nim-twitter]][nim-twitter]
|
|
|
|
* The [forum][nim-forum] - the best place to ask questions and to discuss Nim.
|
|
* [#nim IRC Channel (Freenode)][nim-irc] - a place to discuss Nim in real-time.
|
|
Also where most development decisions get made.
|
|
* [Gitter][nim-gitter] - an additional place to discuss Nim in real-time. There
|
|
is a bridge between Gitter and the IRC channel.
|
|
* [Stack Overflow][nim-stackoverflow] - a popular Q/A site for programming related
|
|
topics that includes posts about Nim.
|
|
* [Github Wiki][nim-wiki] - Misc user-contributed content.
|
|
|
|
## Compiling
|
|
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
|
|
[``nim-lang/csources``][csources-repo] repository.
|
|
|
|
Next, to build from source you will need:
|
|
|
|
* A C compiler such as ``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.
|
|
* Either ``git`` or ``wget`` to download the needed source repositories.
|
|
* The ``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
|
|
``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](doc/koch.rst) file.
|
|
|
|
## Nimble
|
|
``nimble`` is Nim's package manager and it can be acquired from the
|
|
[``nim-lang/nimble``][nimble-repo] 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.
|
|
|
|
|
|
## Contributors
|
|
|
|
This project exists thanks to all the people who contribute. [Read on to find out how to contribute](#contributing).
|
|
<a href="https://github.com/nim-lang/Nim/graphs/contributors"><img src="https://opencollective.com/Nim/contributors.svg?width=890" /></a>
|
|
|
|
## Contributing
|
|
[](#backers) [](#sponsors)
|
|
[![Setup a bounty via Bountysource][badge-nim-bountysource]][nim-bountysource]
|
|
[![Donate Bitcoins][badge-nim-bitcoin]][nim-bitcoin]
|
|
[](https://www.codetriage.com/nim-lang/nim)
|
|
|
|
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:
|
|
|
|
* ``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``][nimsuggest-repo] 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][nim-site].
|
|
* ``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][pull-request-instructions].
|
|
|
|
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 ``tests/untestable``.
|
|
|
|
If you're looking for ways to contribute, please look at our [issue tracker][nim-issues].
|
|
There are always plenty of issues labelled [``Easy``][nim-issues-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:
|
|
|
|
* [Open Collective](https://opencollective.com/nim)
|
|
* [Bountysource][nim-bountysource]
|
|
* [Bitcoin][nim-bitcoin]
|
|
|
|
If you have any questions feel free to submit a question on the
|
|
[Nim forum][nim-forum], or via IRC on [the \#nim channel][nim-irc].
|
|
|
|
|
|
## Backers
|
|
|
|
Thank you to all our backers! [[Become a backer](https://opencollective.com/Nim#backer)]
|
|
|
|
<a href="https://opencollective.com/Nim#backers" target="_blank"><img src="https://opencollective.com/Nim/backers.svg?width=890"></a>
|
|
|
|
|
|
## Sponsors
|
|
|
|
Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/Nim#sponsor)]
|
|
|
|
<a href="https://opencollective.com/Nim/sponsor/0/website" target="_blank"><img src="https://opencollective.com/Nim/sponsor/0/avatar.svg"></a>
|
|
<a href="https://opencollective.com/Nim/sponsor/1/website" target="_blank"><img src="https://opencollective.com/Nim/sponsor/1/avatar.svg"></a>
|
|
<a href="https://opencollective.com/Nim/sponsor/2/website" target="_blank"><img src="https://opencollective.com/Nim/sponsor/2/avatar.svg"></a>
|
|
<a href="https://opencollective.com/Nim/sponsor/3/website" target="_blank"><img src="https://opencollective.com/Nim/sponsor/3/avatar.svg"></a>
|
|
<a href="https://opencollective.com/Nim/sponsor/4/website" target="_blank"><img src="https://opencollective.com/Nim/sponsor/4/avatar.svg"></a>
|
|
<a href="https://opencollective.com/Nim/sponsor/5/website" target="_blank"><img src="https://opencollective.com/Nim/sponsor/5/avatar.svg"></a>
|
|
<a href="https://opencollective.com/Nim/sponsor/6/website" target="_blank"><img src="https://opencollective.com/Nim/sponsor/6/avatar.svg"></a>
|
|
<a href="https://opencollective.com/Nim/sponsor/7/website" target="_blank"><img src="https://opencollective.com/Nim/sponsor/7/avatar.svg"></a>
|
|
<a href="https://opencollective.com/Nim/sponsor/8/website" target="_blank"><img src="https://opencollective.com/Nim/sponsor/8/avatar.svg"></a>
|
|
<a href="https://opencollective.com/Nim/sponsor/9/website" target="_blank"><img src="https://opencollective.com/Nim/sponsor/9/avatar.svg"></a>
|
|
|
|
You can also see a list of all our sponsors/backers from various payment services on the [sponsors page](https://nim-lang.org/sponsors.html) of our website.
|
|
|
|
## License
|
|
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](copying.txt) file for more details.
|
|
|
|
Copyright © 2006-2017 Andreas Rumpf, all rights reserved.
|
|
|
|
[nim-site]: https://nim-lang.org
|
|
[nim-forum]: https://forum.nim-lang.org
|
|
[nim-issues]: https://github.com/nim-lang/Nim/issues
|
|
[nim-issues-easy]: https://github.com/nim-lang/Nim/labels/Easy
|
|
[nim-irc]: https://webchat.freenode.net/?channels=nim
|
|
[nim-travisci]: https://travis-ci.org/nim-lang/Nim
|
|
[nim-twitter]: https://twitter.com/nim_lang
|
|
[nim-stackoverflow]: https://stackoverflow.com/questions/tagged/nim
|
|
[nim-stackoverflow-newest]: https://stackoverflow.com/questions/tagged/nim?sort=newest&pageSize=15
|
|
[nim-gitter]: https://gitter.im/nim-lang/Nim
|
|
[nim-bountysource]: https://www.bountysource.com/teams/nim
|
|
[nim-bitcoin]: https://blockchain.info/address/1BXfuKM2uvoD6mbx4g5xM3eQhLzkCK77tJ
|
|
[nimble-repo]: https://github.com/nim-lang/nimble
|
|
[nimsuggest-repo]: https://github.com/nim-lang/nimsuggest
|
|
[csources-repo]: https://github.com/nim-lang/csources
|
|
[badge-nim-travisci]: https://img.shields.io/travis/nim-lang/Nim/devel.svg?style=flat-square
|
|
[badge-nim-irc]: https://img.shields.io/badge/chat-on_irc-blue.svg?style=flat-square
|
|
[badge-nim-gitter]: https://img.shields.io/badge/chat-on_gitter-blue.svg?style=flat-square
|
|
[badge-nim-forum-gethelp]: https://img.shields.io/badge/Forum-get%20help-4eb899.svg?style=flat-square
|
|
[badge-nim-twitter]: https://img.shields.io/twitter/follow/nim_lang.svg?style=social
|
|
[badge-nim-stackoverflow]: https://img.shields.io/badge/stackoverflow-nim_tag-yellow.svg?style=flat-square
|
|
[badge-nim-bountysource]: https://img.shields.io/bountysource/team/nim/activity.svg?style=flat-square
|
|
[badge-nim-bitcoin]: https://img.shields.io/badge/bitcoin-1BXfuKM2uvoD6mbx4g5xM3eQhLzkCK77tJ-D69134.svg?style=flat-square
|
|
[pull-request-instructions]: https://help.github.com/articles/using-pull-requests/
|
|
[nim-wiki]: https://github.com/nim-lang/Nim/wiki
|