Skip to content

Commit ab4cfcb

Browse files
authored
Proofreading and editing.
1 parent 29ba18e commit ab4cfcb

File tree

1 file changed

+32
-33
lines changed

1 file changed

+32
-33
lines changed

readme.markdown

Lines changed: 32 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ The Nimble change log can be found [here](https://github.com/nim-lang/nimble/blo
6565
Nimble has some runtime dependencies on external tools, these tools are used to
6666
download Nimble packages. For instance, if a package is hosted on
6767
[GitHub](https://github.com), you need to have [git](https://www.git-scm.com)
68-
installed and added to your environment ``PATH``. Same goes for
68+
installed and added to your environment ``PATH``. The same goes for
6969
[Mercurial](http://mercurial.selenic.com) repositories on
7070
[Bitbucket](https://bitbucket.org). Nimble packages are typically hosted in Git
7171
repositories so you may be able to get away without installing Mercurial.
@@ -81,7 +81,7 @@ feature is supported by both **GitHub** and **BitBucket**.
8181
## Installation
8282

8383
Nimble is now bundled with [Nim](https://nim-lang.org)
84-
(since Nim version 0.15.0).
84+
(as of Nim version 0.15.0).
8585
This means that you should have Nimble installed already, as long as you have
8686
the latest version of Nim installed as well. Because of this **you likely do
8787
not need to install Nimble manually**.
@@ -181,10 +181,10 @@ Example:
181181
nake installed successfully
182182

183183
Nimble always fetches and installs the latest version of a package. Note that
184-
latest version is defined as the latest tagged version in the Git (or Mercurial)
184+
the latest version is defined as the latest tagged version in the Git (or Mercurial)
185185
repository, if the package has no tagged versions then the latest commit in the
186186
remote repository will be installed. If you already have that version installed,
187-
Nimble will ask you whether you wish it to overwrite your local copy.
187+
Nimble will ask you whether you wish to overwrite your local copy.
188188

189189
You can force Nimble to download the latest commit from the package's repo, for
190190
example:
@@ -200,7 +200,7 @@ version range, for example:
200200
$ nimble install [email protected]
201201
$ nimble install nimgame@"> 0.5"
202202

203-
The latter command will install a version which is greater than ``0.5``.
203+
The latter command will install a version that is greater than ``0.5``.
204204

205205
If you don't specify a parameter and there is a ``package.nimble`` file in your
206206
current working directory then Nimble will install the package residing in
@@ -215,7 +215,7 @@ files.
215215

216216
#### Package URLs
217217

218-
A valid URL to a Git or Merurial repository can also be specified, Nimble will
218+
A valid URL to a Git or Mercurial repository can also be specified, Nimble will
219219
automatically detect the type of the repository that the url points to and
220220
install it.
221221

@@ -411,7 +411,7 @@ The command also adds `nimble.develop` and `nimble.paths` files to the
411411
### nimble uninstall
412412

413413
The ``uninstall`` command will remove an installed package. Attempting to remove
414-
a package which other packages depend on will result in an error. You can use the
414+
a package that other packages depend on will result in an error. You can use the
415415
``--inclDeps`` or ``-i`` flag to remove all dependent packages along with the package.
416416

417417
Similar to the ``install`` command you can specify a version range, for example:
@@ -518,7 +518,7 @@ an ini-compatible format. Useful for tools wishing to read metadata about
518518
Nimble packages who do not want to use the NimScript evaluator.
519519

520520
The format can be specified with `--json` or `--ini` (and defaults to `--ini`).
521-
Use `nimble dump pkg` to dump information about provided `pkg` instad.
521+
Use `nimble dump pkg` to dump information about provided `pkg` instead.
522522

523523
## Configuration
524524

@@ -554,7 +554,7 @@ You can currently configure the following in this file:
554554
defaults to the "Official" package list, you can override it by specifying
555555
a ``[PackageList]`` section named "official". Multiple URLs can be specified
556556
under each section, Nimble will try each in succession if
557-
downloading from the first fails. Alternately, ``path`` can specify a
557+
downloading from the first fails. Alternatively, ``path`` can specify a
558558
local file path to copy a package list .json file from.
559559
* ``cloneUsingHttps`` - Whether to replace any ``git://`` inside URLs with
560560
``https://``.
@@ -640,13 +640,13 @@ requires "choosenim ~= 0" # choosenim >= 0.0.0 & < 1.0.0
640640
requires "choosenim ^= 0" # choosenim >= 0.0.0 & < 1.0.0
641641
```
642642

643-
Nimble currently supports installation of packages from a local directory, a
643+
Nimble currently supports the installation of packages from a local directory, a
644644
Git repository and a mercurial repository. The .nimble file must be present in
645645
the root of the directory or repository being installed.
646646

647647
The .nimble file is very flexible because it is interpreted using NimScript.
648-
Because of Nim's flexibility the definitions remain declarative. With the added
649-
ability of using the Nim language to enrich your package specification.
648+
Because of Nim's flexibility, the definitions remain declarative. With the added
649+
ability to use the Nim language to enrich your package specification.
650650
For example, you can define dependencies for specific platforms using Nim's
651651
``when`` statement.
652652

@@ -676,7 +676,7 @@ which makes this feature very powerful.
676676
You can also check what tasks are supported by the package in the current
677677
directory by using the ``tasks`` command.
678678

679-
Nimble provides an API which adds even more functionality. For example,
679+
Nimble provides an API that adds even more functionality. For example,
680680
you can specify
681681
pre and post hooks for any Nimble command (including commands that
682682
you define yourself). To do this you can add something like the following:
@@ -707,7 +707,7 @@ flags are those specified before the task name and are forwarded to the Nim
707707
compiler that runs the `.nimble` task. This enables setting `--define:xxx`
708708
values that can be checked with `when defined(xxx)` in the task, and other
709709
compiler flags that are applicable in Nimscript mode. Run flags are those after
710-
the task name and are available as command line arguments to the task. They can
710+
the task name and are available as command-line arguments to the task. They can
711711
be accessed per usual from `commandLineParams: seq[string]`.
712712

713713
In order to forward compiler flags to `exec("nim ...")` calls executed within a
@@ -785,7 +785,7 @@ be solved in a few different ways:
785785
* Use a simple path modification to resolve the package properly.
786786

787787
The latter is highly recommended. Reinstalling the package to test an actively
788-
changing code base is a massive pain.
788+
changing codebase is a massive pain.
789789

790790
To modify the path for your tests only, simply add a ``nim.cfg`` file into
791791
your ``tests`` directory with the following contents:
@@ -794,7 +794,7 @@ your ``tests`` directory with the following contents:
794794
--path:"../src/"
795795
```
796796

797-
Nimble offers a pre-defined ``test`` task which compiles and runs all files
797+
Nimble offers a pre-defined ``test`` task that compiles and runs all files
798798
in the ``tests`` directory beginning with 't' in their filename. Nim flags
799799
provided to `nimble test` will be forwarded to the compiler when building
800800
the tests.
@@ -825,14 +825,14 @@ determined by the nature of your package, that is, whether your package exposes
825825
only one module or multiple modules.
826826

827827
If your package exposes only a single module, then that module should be
828-
present in the source directory of your Git repository, and should be named
828+
present in the source directory of your Git repository and should be named
829829
whatever your package's name is. A good example of this is the
830830
[jester](https://github.com/dom96/jester) package which exposes the ``jester``
831-
module. In this case the jester package is imported with ``import jester``.
831+
module. In this case, the jester package is imported with ``import jester``.
832832

833833
If your package exposes multiple modules then the modules should be in a
834834
``PackageName`` directory. This will allow for a certain measure of isolation
835-
from other packages which expose modules with the same names. In this case
835+
from other packages which expose modules with the same names. In this case,
836836
the package's modules will be imported with ``import PackageName/module``.
837837

838838
Here's a simple example multi-module library package called `kool`:
@@ -850,7 +850,7 @@ them in a ``PackageName/private`` directory. Your modules may then import these
850850
private modules with ``import PackageName/private/module``. This directory
851851
structure may be enforced in the future.
852852

853-
All files and folders in the directory of where the .nimble file resides will be
853+
All files and folders in the directory where the .nimble file resides will be
854854
copied as-is, you can however skip some directories or files by setting
855855
the ``skipDirs``, ``skipFiles`` or ``skipExt`` options in your .nimble file.
856856
Directories and files can also be specified on a *whitelist* basis, if you
@@ -869,7 +869,7 @@ bin = @["main"]
869869

870870
In this case when ``nimble install`` is invoked, Nimble will build the ``main.nim``
871871
file, copy it into ``$nimbleDir/pkgs/pkgname-ver/`` and subsequently create a
872-
symlink to the binary in ``$nimbleDir/bin/``. On Windows a stub .cmd file is
872+
symlink to the binary in ``$nimbleDir/bin/``. On Windows, a stub .cmd file is
873873
created instead.
874874

875875
The binary can be named differently than the source file with the ``namedBin``
@@ -932,8 +932,7 @@ latest commit of Jester.
932932
related to it are more likely to be introduced than for any other Nimble
933933
features.
934934

935-
Starting with Nimble v0.8.0, you can now specify external dependencies. These
936-
are dependencies which are not managed by Nimble and can only be installed via
935+
Starting with Nimble v0.8.0, you can now specify external dependencies. These dependencies are not managed by Nimble and can only be installed via
937936
your system's package manager or downloaded manually via the internet.
938937

939938
As an example, to specify a dependency on openssl you may put this in your
@@ -969,11 +968,11 @@ installing your package (on macOS):
969968
Versions of cloned packages via Git or Mercurial are determined through the
970969
repository's *tags*.
971970

972-
When installing a package which needs to be downloaded, after the download is
971+
When installing a package that needs to be downloaded, after the download is
973972
complete and if the package is distributed through a VCS, Nimble will check the
974973
cloned repository's tags list. If no tags exist, Nimble will simply install the
975974
HEAD (or tip in Mercurial) of the repository. If tags exist, Nimble will attempt
976-
to look for tags which resemble versions (e.g. v0.1) and will then find the
975+
to look for tags that resemble versions (e.g. v0.1) and will then find the
977976
latest version out of the available tags, once it does so it will install the
978977
package after checking out the latest version.
979978

@@ -1001,7 +1000,7 @@ the new version.
10011000

10021001
##### Git Version Tagging
10031002

1004-
Use dot separated numbers to represent the release version in the git
1003+
Use dot-separated numbers to represent the release version in the git
10051004
tag label. Nimble will parse these git tag labels to know which
10061005
versions of a package are published.
10071006

@@ -1019,12 +1018,12 @@ a specific name to a URL pointing to your package. This mapping is stored
10191018
in an official packages repository located
10201019
[here](https://github.com/nim-lang/packages).
10211020

1022-
This repository contains a ``packages.json`` file which lists all the published
1021+
This repository contains a ``packages.json`` file that lists all the published
10231022
packages. It contains a set of package names with associated metadata. You
10241023
can read more about this metadata in the
10251024
[readme for the packages repository](https://github.com/nim-lang/packages#readme).
10261025

1027-
To publish your package you need to fork that repository, and add an entry
1026+
To publish your package you need to fork that repository and add an entry
10281027
into the ``packages.json`` file for your package. Then create a pull request
10291028
with your changes. **You only need to do this
10301029
once**.
@@ -1042,7 +1041,7 @@ Nimble includes a ``publish`` command which does this for you automatically.
10421041
**before** tagging the current version using ``git tag`` or ``hg tag``.
10431042
* ``author`` - The name of the author of this package.
10441043
* ``description`` - A string describing the package.
1045-
* ``license`` - The name of the license in which this package is licensed under.
1044+
* ``license`` - The name of the license under which this package is licensed.
10461045

10471046
#### Optional
10481047

@@ -1112,7 +1111,7 @@ ignored. This allows for project local dependencies and isolation from other
11121111
projects. The `-l | --localdeps` flag can be used to setup a project in local
11131112
dependency mode.
11141113

1115-
Nimble also allows overriding ``$nimbleDir`` on the command line with the
1114+
Nimble also allows overriding ``$nimbleDir`` on the command-line with the
11161115
``--nimbleDir`` flag or the ``NIMBLE_DIR`` environment variable if required.
11171116

11181117
If the default ``$HOME/.nimble`` is overridden by one of the above methods,
@@ -1128,7 +1127,7 @@ in Nimble's package directory when compiling your software. This means that
11281127
it cannot resolve dependencies, and it can only use the latest version of a
11291128
package when compiling.
11301129

1131-
When Nimble builds your package it actually executes the Nim compiler.
1130+
When Nimble builds your package it executes the Nim compiler.
11321131
It resolves the dependencies and feeds the path of each package to
11331132
the compiler so that it knows precisely which version to use.
11341133

@@ -1191,9 +1190,9 @@ Make sure that you are running at least version 0.16.0 of Nim (or the latest nig
11911190
* ``Error: cannot open '/home/user/.nimble/lib/system.nim'.``
11921191

11931192
Nimble cannot find the Nim standard library. This is considered a bug so
1194-
please report it. As a workaround you can set the ``NIM_LIB_PREFIX`` environment
1193+
please report it. As a workaround, you can set the ``NIM_LIB_PREFIX`` environment
11951194
variable to the directory where ``lib/system.nim`` (and other standard library
1196-
files) are found. Alternatively you can also configure this in Nimble's
1195+
files) are found. Alternatively, you can also configure this in Nimble's
11971196
config file.
11981197

11991198
## Repository information

0 commit comments

Comments
 (0)