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

Documented config file and improved docs.

Browse source
This commit is contained in:
Dominik Picheta 2014-06-20 23:30:18 +01:00
commit 30b8700ac4
1 changed files with 23 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

23
readme.markdown
View file

@ -3,6 +3,11 @@
Babel is a *beta*-grade *package manager* for the [Nimrod programming Babel is a *beta*-grade *package manager* for the [Nimrod programming
language](http://nimrod-lang.org). language](http://nimrod-lang.org).
**Note:** This readme explains how to install and use babel. It does not
explain how to create babel packages. Take a look at the
[developers.markdown file](developers.markdown) for information regarding
package creation.
## Installation ## Installation
You will need version 0.9.4 of the [Nimrod You will need version 0.9.4 of the [Nimrod
@ -172,6 +177,24 @@ which can be useful to read the bundled documentation. Example:
$ cd `babel path argument_parser` $ cd `babel path argument_parser`
$ less README.md $ less README.md
## Configuration
At startup Babel will attempt to read ``$AppDir/babel/babel.ini``,
where ``$AppDir`` is ``~/.config/`` on Linux and
``C:\Users\<YourUser>\AppData\Roaming\`` on Windows.
The format of this file corresponds to the ini format with some Nimrod
enhancements. For example:
```ini
babelDir = r"C:\Babel\"
```
You can currently configure the following in this file:
* ``babelDir`` - The directory which babel uses for package installation.
**Default:** ``~/.babel/``
## Packages ## Packages
Babel works on git repositories as its primary source of packages. Its list of Babel works on git repositories as its primary source of packages. Its list of