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

Added implementation details about .nimble-link files to readme.

Browse source
This commit is contained in:
Dominik Picheta 2017-08-28 23:00:56 +01:00
commit 43489da1f2
1 changed files with 15 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

15
readme.markdown
View file

@ -860,6 +860,21 @@ If you have any questions about the project you can ask me directly on github,
ask on the Nim [forum](http://forum.nim-lang.org), or ask on Freenode in
the #nim channel.
## Implementation details
### .nimble-link
These files are created by Nimble when using the ``develop`` command. They
are very simple and contain two lines.
**The first line:** Always a path to the `.nimble` file.
**The second line:** Always a path to the Nimble package's source code. Usually
``$pkgDir/src``, depending on what ``srcDir`` is set to.
The paths written by Nimble are **always** absolute. But Nimble (and the
Nim compiler) also supports relative paths, which will be read relative to
the `.nimble-link` file.
## About
Nimble has been written by [Dominik Picheta](http://picheta.me/) with help from