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

Add packaging guide #5182 (#10384)

Browse source
This commit is contained in:
Federico Ceratto 2019-01-23 10:12:46 +00:00 • committed by Andreas Rumpf
commit c3229dc1c3
3 changed files with 75 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

6
readme.md
View file

@ -5,6 +5,7 @@ For more information about Nim, including downloads and documentation for
the latest release, check out [Nim's website][nim-site] or [bleeding edge docs](https://nim-lang.github.io/Nim/).
## 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]
@ -23,6 +24,7 @@ the latest release, check out [Nim's website][nim-site] or [bleeding edge docs](
* [Github Wiki][nim-wiki] - Misc user-contributed content.
## Compiling
The compiler currently officially supports the following platform and
architecture combinations:
@ -56,6 +58,8 @@ Nim from source using ``gcc``, ``git`` and the ``koch`` build tool.
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.
For package mantainers: see [packaging guidelines](https://nim-lang.github.io/Nim/packaging.html).
```
# step 1:
git clone https://github.com/nim-lang/Nim.git
@ -83,6 +87,7 @@ 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.
@ -106,6 +111,7 @@ This project exists thanks to all the people who contribute.
<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]