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

Readme fixes regarding NimScript support.

Browse source
This commit is contained in:
Dominik Picheta 2015-12-24 01:31:50 +00:00
commit bc9b023db0
1 changed files with 7 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

10
readme.markdown
View file

@ -233,7 +233,8 @@ which can be useful to read the bundled documentation. Example:
The nimble ``init`` command will start a simple wizard which will create The nimble ``init`` command will start a simple wizard which will create
a quick ``.nimble`` file for your project. a quick ``.nimble`` file for your project.
As of version 0.7.0, this ``.nimble`` file will use the new NimScript format. As of version 0.7.0, the ``.nimble`` file that this command creates will
use the new NimScript format.
Check out the [Creating Packages](#creating-packages) section for more info. Check out the [Creating Packages](#creating-packages) section for more info.
### nimble publish ### nimble publish
@ -244,7 +245,7 @@ Publishes your Nimble package to the official Nimble package repository.
### nimble tasks ### nimble tasks
For a nimble package in current working directory, list the tasks which that For a nimble package in the current working directory, list the tasks which that
package defines. This is only supported for packages utilising the new package defines. This is only supported for packages utilising the new
nimscript .nimble files. nimscript .nimble files.
@ -373,6 +374,9 @@ access the FFI. The ``nimscript``
additional functionality such as the ability to execute external processes additional functionality such as the ability to execute external processes
which makes this feature very powerful. which makes this feature very powerful.
You can also check what tasks are supported by the package in the current
directory by using the ``tasks`` command.
### Libraries ### Libraries
Library packages are likely the most popular form of Nimble packages. They are Library packages are likely the most popular form of Nimble packages. They are
@ -518,7 +522,7 @@ their own packages to it! Take a look at
#### Required #### Required
* ``name`` - The name of the package. * ``name`` - The name of the package. *(This is not required in the new NimScript format)*
* ``version`` - The *current* version of this package. This should be incremented * ``version`` - The *current* version of this package. This should be incremented
**after** tagging the current version using ``git tag`` or ``hg tag``. **after** tagging the current version using ``git tag`` or ``hg tag``.
* ``author`` - The name of the author of this package. * ``author`` - The name of the author of this package.