Browse Source

Add note on what gets searched for

master v0.1.0
Brett Langdon 11 years ago
parent
commit
69dafc3e50
1 changed files with 10 additions and 0 deletions
  1. +10
    -0
      README.md

+ 10
- 0
README.md View File

@ -81,6 +81,16 @@ for build in builds:
Look for an appropriate `name` file or directory in the directory `directory`
and parse all possible build configurations found.
`parse` defaults to looking for the following files:
* `.build.yml`
* `.build.yaml`
* `.build.json`
* `.build.ini`
* `.build.cfg`
or for the directory `.build` which contains one or many configuration files
(name doesn't have to be "build").
## parse_directory(dir_name)
*returns*: list


Loading…
Cancel
Save