diff options
Diffstat (limited to 'readme.md')
| -rw-r--r-- | readme.md | 12 |
1 files changed, 6 insertions, 6 deletions
diff --git a/readme.md b/readme.md index 5480047a4..f6122c1e8 100644 --- a/readme.md +++ b/readme.md @@ -39,7 +39,7 @@ 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 programming language. Those C sources are available within the [``nim-lang/csources``][csources-repo] repository. Next, to build from source you will need: @@ -49,7 +49,7 @@ Next, to build from source you will need: 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). + 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. @@ -58,7 +58,7 @@ 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). +For package maintainers: see [packaging guidelines](https://nim-lang.github.io/Nim/packaging.html). ``` # step 1: @@ -90,11 +90,11 @@ 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. +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 +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 @@ -126,7 +126,7 @@ 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. +* ``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: |