Expand Nimble readme slightly (installation/nimble-run).
This commit is contained in:
parent
b68f7849e6
commit
3625c1f861
1 changed files with 29 additions and 3 deletions
|
|
@ -15,6 +15,7 @@ Interested in learning **how to create a package**? Skip directly to that sectio
|
||||||
- [nimble install](#nimble-install)
|
- [nimble install](#nimble-install)
|
||||||
- [nimble uninstall](#nimble-uninstall)
|
- [nimble uninstall](#nimble-uninstall)
|
||||||
- [nimble build](#nimble-build)
|
- [nimble build](#nimble-build)
|
||||||
|
- [nimble run](#nimble-run)
|
||||||
- [nimble c](#nimble-c)
|
- [nimble c](#nimble-c)
|
||||||
- [nimble list](#nimble-list)
|
- [nimble list](#nimble-list)
|
||||||
- [nimble search](#nimble-search)
|
- [nimble search](#nimble-search)
|
||||||
|
|
@ -74,10 +75,15 @@ not need to install Nimble manually**.
|
||||||
But in case you still want to install Nimble manually, you can follow the
|
But in case you still want to install Nimble manually, you can follow the
|
||||||
following instructions.
|
following instructions.
|
||||||
|
|
||||||
There are two ways to install Nimble manually. The first is using the
|
There are two ways to install Nimble manually. Using ``koch`` and using Nimble
|
||||||
``koch`` tool included in the Nim distribution and
|
itself.
|
||||||
|
|
||||||
|
### Using koch
|
||||||
|
|
||||||
|
The ``koch`` tool is included in the Nim distribution and
|
||||||
[repository](https://github.com/nim-lang/Nim/blob/devel/koch.nim).
|
[repository](https://github.com/nim-lang/Nim/blob/devel/koch.nim).
|
||||||
Simply execute the following command to compile and install Nimble.
|
Simply navigate to the location of your Nim installation and execute the
|
||||||
|
following command to compile and install Nimble.
|
||||||
|
|
||||||
```
|
```
|
||||||
./koch nimble
|
./koch nimble
|
||||||
|
|
@ -86,6 +92,19 @@ Simply execute the following command to compile and install Nimble.
|
||||||
This will clone the Nimble repository, compile Nimble and copy it into
|
This will clone the Nimble repository, compile Nimble and copy it into
|
||||||
Nim's bin directory.
|
Nim's bin directory.
|
||||||
|
|
||||||
|
### Using Nimble
|
||||||
|
|
||||||
|
In most cases you will already have Nimble installed, you can install a newer
|
||||||
|
version of Nimble by simply running the following command:
|
||||||
|
|
||||||
|
```
|
||||||
|
nimble install nimble
|
||||||
|
```
|
||||||
|
|
||||||
|
This will download the latest release of Nimble and install it on your system.
|
||||||
|
|
||||||
|
Note that you must have `~/.nimble/bin` in your PATH for this to work, if you're
|
||||||
|
using choosenim then you likely already have this set up correctly.
|
||||||
|
|
||||||
## Nimble usage
|
## Nimble usage
|
||||||
|
|
||||||
|
|
@ -219,6 +238,13 @@ flags, i.e. a debug build which includes stack traces but no GDB debug
|
||||||
information. The ``install`` command will build the package in release mode
|
information. The ``install`` command will build the package in release mode
|
||||||
instead.
|
instead.
|
||||||
|
|
||||||
|
### nimble run
|
||||||
|
|
||||||
|
The ``run`` command can be used to build and run any binary specified in your
|
||||||
|
package's ``bin`` list. You can pass any compilation flags you wish by specifying
|
||||||
|
them before the ``run`` command, and you can specify arguments for your binary
|
||||||
|
by specifying them after the ``run`` command.
|
||||||
|
|
||||||
### nimble c
|
### nimble c
|
||||||
|
|
||||||
The ``c`` (or ``compile``, ``js``, ``cc``, ``cpp``) command can be used by
|
The ``c`` (or ``compile``, ``js``, ``cc``, ``cpp``) command can be used by
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue