summary refs log tree commit diff stats
path: root/readme.md
Commit message (Expand)AuthorAgeFilesLines
* complete removal of web folder, fixes #9304 (#9310)Miran2018-10-121-1/+0
* make contributing.rst more up to date; reference it in readme.md to make it m...Timothee Cour2018-10-111-1/+2
* add link to https://nim-lang.github.io/Nim/ in readme.mdTimothee Cour2018-10-031-1/+1
* add build_all.sh to allow 1-liner to build development version of the compile...Timothee Cour2018-08-081-8/+17
* Years were updated.data-man2018-05-311-1/+1
* Added Telegram channel to readme.data-man2018-05-311-0/+3
* Some more fixes to the readme.Dominik Picheta2018-04-011-1/+1
* Improve compilation instructions in readmeDominik Picheta2018-04-011-4/+7
* Add CodeTriage badge to nim-lang/nimcodetriage-readme-bot2018-02-021-0/+1
* Gratipay is deadJuan Francisco Cantero Hurtado2018-01-231-4/+1
* Add comments on "untestable" tests directoryFederico Ceratto2017-11-031-0/+1
* Felt this paragraph was a little grammatically awkward.Aaron Salvo2017-10-261-4/+4
* Add a link to the github wikiwizzardx2017-10-251-0/+2
* improved wording style (#6527)Kobi Lurie2017-10-181-1/+1
* remove stupid shell dollar signs that make copypasta hard (#6354)Tristan B. Kildaire2017-09-111-8/+8
* Small fix to READMEDaniil Yarancev2017-08-061-1/+1
* Small fixes to readme after #6160.Dominik Picheta2017-07-301-3/+3
* updated readme.mdXavier Damman2017-07-301-1/+33
* Fixed nimsuggest in readmeFredrik Høisæther Rasch2017-05-181-3/+2
* Fix huge logo in readme.Dominik Picheta2017-04-151-2/+1
* Fix typo in readme.md (there is no "build-essentials" package in Debian)Hugo Locurcio2017-03-071-1/+1
* Make additional minor changes to readme.mdEmily Mabrey2017-02-091-24/+26
* Cleanup and reorganize readme.mdEmily Mabrey2017-02-091-110/+137
* minor website improvementAndreas Rumpf2017-01-291-1/+1
* Remove Build status waterfall, all links 502 (#5249)timothy eichler2017-01-191-30/+0
* Small fixes in readme.Dominik Picheta2017-01-081-1/+1
* document the new way of doing things; refs #4934Araq2016-10-241-2/+3
* remove outdated warning about the Nimble installation processAraq2016-10-081-6/+0
* install_tools is not for building by sourceAraq2016-10-081-7/+0
* more documentation knows about the new install_tools.nims scriptAraq2016-09-281-0/+8
* Added Gitter links to readmeRuslan Mustakov2016-09-021-1/+4
* fix several broken linksmiere432016-07-311-1/+1
* Add note about build-essentials package to readmeDominik Picheta2016-07-311-0/+2
* Many additions to readme.Dominik Picheta2016-04-051-22/+82
* Switch git clone URLs to HTTPSFederico Ceratto2016-01-231-2/+2
* fixes some typosAndreas Rumpf2016-01-191-1/+1
* More badges for readme!Dominik Picheta2016-01-031-1/+9
* readme.md: Open builder page from its status iconAdam Strzelecki2015-10-131-3/+11
* Update readme.mdVarriount2015-10-101-5/+5
* Update readme.mdVarriount2015-10-101-1/+0
* Add newline after Gitter imageDominik Picheta2015-09-231-0/+2
* Add Gitter badgeThe Gitter Badger2015-09-231-0/+2
* Nimble is officially a part of Nim nowAraq2015-09-051-3/+15
* fixes readme.md typoKazunori Kajihiro2015-07-021-1/+1
* no more prebuilt sourcesSimon Hafner2015-03-091-4/+0
* Move bot url to botbuildZhiFeng Hu2015-03-091-8/+8
* Update readme.mdAndreas Rumpf2015-03-031-2/+1
* It's 2015 :+1:M.Yasoob Ullah Khalid ☺2015-02-151-1/+1
* Clean up build iconsFlaviu Tamas2015-02-071-5/+21
* Revert "Documented faster way to bootstrap-build Nim"Varriount2015-01-171-8/+10
u 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. To learn more about it, see the [``nim-lang/nimble``][nimble-repo] 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 on Open Collective](https://opencollective.com/nim/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/nim/sponsors/badge.svg)](#sponsors) [![Setup a bounty via Bountysource][badge-nim-bountysource]][nim-bountysource] [![Donate Bitcoins][badge-nim-bitcoin]][nim-bitcoin] [![Open Source Helpers](https://www.codetriage.com/nim-lang/nim/badges/users.svg)](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-2018 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-telegram]: https://t.me/nim_lang [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