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

Make additional minor changes to readme.md

Browse source 
Move the community section closer to the top of the readme. Make the
reference to the copying.txt file in the license section actually
link to that file. Adjust the nimble section to be more clear about
how and where to acquire the nimble source.
This commit is contained in:
Emily Mabrey 2017-02-09 17:33:19 -05:00
commit 1a7fdb09d9
No known key found for this signature in database
GPG key ID: 6F4EF47256A1B7DC
1 changed files with 26 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

50
readme.md
View file

@ -4,6 +4,21 @@ This repository contains the Nim compiler, Nim's stdlib, tools and documentation
For more information about Nim, including downloads and documentation for For more information about Nim, including downloads and documentation for
the latest release, check out [Nim's website][nim-site]. 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.
## Compiling ## Compiling
The compiler currently officially supports the following platform and The compiler currently officially supports the following platform and
architecture combinations: architecture combinations:
@ -15,10 +30,11 @@ architecture combinations:
More platforms are supported, however they are not tested regularly and they More platforms are supported, however they are not tested regularly and they
may not be as stable as the above-listed platforms. may not be as stable as the above-listed platforms.
Compiling the Nim compiler is quite straightforward. First, the C source of Compiling the Nim compiler is quite straightforward if you follow these steps:
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 First, the C source of an older version of the Nim compiler is needed to
language. Those C sources are available within the 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. [``nim-lang/csources``][csources-repo] repository.
Next, to build from source you will need: Next, to build from source you will need:
@ -55,7 +71,7 @@ documentation and the website, among other things. The ``koch`` tool can also
be used to run the Nim test suite. be used to run the Nim test suite.
Assuming that you added Nim's ``bin`` directory to your PATH, you may execute Assuming that you added Nim's ``bin`` directory to your PATH, you may execute
the tests using ``./koch tests``. The test suite takes a while to run, but you 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 can run a subset of tests by specifying a category (for example
``./koch tests cat async``). ``./koch tests cat async``).
@ -63,24 +79,10 @@ For more information on the ``koch`` build tool please see the documentation
within the [doc/koch.rst](doc/koch.rst) file. within the [doc/koch.rst](doc/koch.rst) file.
## Nimble ## Nimble
[Nimble][nimble-repo] is Nim's package manager. Assuming that you added Nim's ``nimble`` is Nim's package manager and it can be acquired from the
``bin`` directory to your PATH, you may install Nimble by running ``koch nimble`` [``nim-lang/nimble``][nimble-repo] repository. Assuming that you added Nim's
within the root of the cloned repository. ``bin`` directory to your PATH, you may install Nimble from source by running
``koch nimble`` within the root of the cloned repository.
## 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.
## Contributing ## Contributing
[![Contribute to Nim via Gratipay][badge-nim-gratipay]][nim-gratipay] [![Contribute to Nim via Gratipay][badge-nim-gratipay]][nim-gratipay]
@ -140,7 +142,7 @@ 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 compatible license (essentially any license) for your own programs developed with
Nim. You are explicitly permitted to develop commercial applications using Nim. Nim. You are explicitly permitted to develop commercial applications using Nim.
Please read the copying.txt file for more details. Please read the [copying.txt](copying.txt) file for more details.
Copyright © 2006-2017 Andreas Rumpf, all rights reserved. Copyright © 2006-2017 Andreas Rumpf, all rights reserved.