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

Readme improvements.

Browse source
This commit is contained in:
Dominik Picheta 2014-12-25 21:54:39 +00:00
commit 54a0361704
1 changed files with 33 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

41
readme.markdown
View file

@ -26,7 +26,7 @@ On Unix operating systems Nimble can be compiled and installed with two simple
commands. After successfully grabbing the latest Nimrod compiler simply execute commands. After successfully grabbing the latest Nimrod compiler simply execute
the following commands to clone nimble, compile it and then install it. the following commands to clone nimble, compile it and then install it.
git clone https://github.com/nimrod-code/nimble.git git clone https://github.com/nim-lang/nimble.git
cd nimble cd nimble
nimrod c -r src/nimble install nimrod c -r src/nimble install
@ -36,15 +36,36 @@ executing ``nimble install nimble``.
### Windows ### Windows
On Windows installing Nimble is slightly more complex: You can install via a pre-built installation archive which is
available on the [releases](https://github.com/nim-lang/nimble/releases) page
or from source.
git clone https://github.com/nimrod-code/nimble.git #### Using the pre-built archives
Download the latest release archive from the
[releases](https://github.com/nim-lang/nimble/releases) page. These archives
will have a filename of the form ``nimble-x_win32`` where ``x`` is the
current version.
Once you download that archive unzip it and execute the ``install.bat`` file.
One important thing to note is that this installation requires you have
the Nim compiler in your PATH. Once the installation completes you should
add ``C:\Users\YourName\.nimble\bin`` to your PATH.
#### From source
On Windows installing Nimble from source is slightly more complex:
git clone https://github.com/nim-lang/nimble.git
cd nimble cd nimble
nimrod c src\nimble nimrod c src\nimble
cp src\nimble.exe src\nimble1.exe cp src\nimble.exe src\nimble1.exe
src\nimble1.exe install src\nimble1.exe install
This is required because Windows will lock the process which is being run. This is required because Windows will lock the process which is being run and
during installation Nimble will recompile itself.
Once the installation completes you should
add ``C:\Users\YourName\.nimble\bin`` to your PATH.
## Nimble's folder structure and packages ## Nimble's folder structure and packages
@ -211,12 +232,16 @@ You can currently configure the following in this file:
* ``nimbleDir`` - The directory which nimble uses for package installation. * ``nimbleDir`` - The directory which nimble uses for package installation.
**Default:** ``~/.nimble/`` **Default:** ``~/.nimble/``
* ``chcp`` - Whether to change the current code page when executing Nim
application packages. If ``true`` this will add ``chcp 65001`` to the
.cmd stubs generated in ``~/.nimble/bin/``.
**Default:** ``true``
## Packages ## Packages
Nimble works on git repositories as its primary source of packages. Its list of Nimble works on git repositories as its primary source of packages. Its list of
packages is stored in a JSON file which is freely accessible in the packages is stored in a JSON file which is freely accessible in the
[nimrod-code/packages repository](https://github.com/nimrod-code/packages). [nimrod-code/packages repository](https://github.com/nim-lang/packages).
This JSON file provides nimble with the required Git URL to clone the package This JSON file provides nimble with the required Git URL to clone the package
and install it. Installation and build instructions are contained inside a and install it. Installation and build instructions are contained inside a
ini-style file with the ``.nimble`` file extension. The nimble file shares the ini-style file with the ``.nimble`` file extension. The nimble file shares the
@ -230,12 +255,12 @@ Nimble packages please read the [developers.markdown file](developers.markdown)
for detailed information. for detailed information.
If you have any questions about the project you can ask me directly on github, If you have any questions about the project you can ask me directly on github,
ask on the nimrod [forum](http://forum.nimrod-code.org), or ask on Freenode in ask on the Nim [forum](http://forum.nim-lang.org), or ask on Freenode in
the #nimrod channel. the #nim channel.
## About ## About
Nimble has been written by [Dominik Picheta](http://picheta.me/) with help from Nimble has been written by [Dominik Picheta](http://picheta.me/) with help from
a number of a number of
[contributors](https://github.com/nimrod-code/nimble/graphs/contributors). [contributors](https://github.com/nim-lang/nimble/graphs/contributors).
It is licensed under the BSD license (Look at license.txt for more info). It is licensed under the BSD license (Look at license.txt for more info).