Anshorei
/
squib
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Added a line for built-in layouts

dev
Andy Meneely 2014-12-07 23:06:44 -05:00
parent 270577962b
commit 501dc417d0
1 changed files with 6 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -201,7 +201,7 @@ yang:
### Multiple layout files ### Multiple layout files
Squib also supports the combination of multiple layout files. As shown in the above example, if you provide an `Array` of files then Squib will merge them sequentially. Colliding keys will be completely re-defined by the later file. Extends is processed after _each_ file. YAML merge keys are NOT supported across multiple files (use extends instead). Here's a demonstrative example: Squib also supports the combination of multiple layout files. As shown in the above example, if you provide an `Array` of files then Squib will merge them sequentially. Colliding keys will be completely re-defined by the later file. Extends is processed after _each file_. YAML merge keys are NOT supported across multiple files - use extends instead. Here's a demonstrative example:
```yaml ```yaml
# load order: a.yml, b.yml # load order: a.yml, b.yml
@ -214,7 +214,7 @@ grandparent:
parent_a: parent_a:
extends: grandparent extends: grandparent
x: += 10 # evaluates to 110 x: += 10 # evaluates to 110
parent_b: parent_b:
extends: grandparent extends: grandparent
x: += 20 # evaluates to 120 x: += 20 # evaluates to 120
@ -236,6 +236,10 @@ This can hopefully be helpful for:
* Creating a base layout for structure, and one for color (for easier color/black-and-white switching) * Creating a base layout for structure, and one for color (for easier color/black-and-white switching)
* Sharing base layouts with other designers * Sharing base layouts with other designers
### Built-in Layout Files
If your layout file is not found in the current directory, Squib will search for its own set of layout files (here's the latest the development version [on GitHub](https://github.com/andymeneely/squib/tree/master/lib/squib/layouts). See the `layouts.rb` sample found [here](https://github.com/andymeneely/squib/tree/master/samples/) for some demonstrative examples.
## Configuration File ## Configuration File
Squib supports various configuration properties that can be specified in an external file. The `config:` option in `Deck.new` can specify an optional configuration file in YML format. The properties there are intended to be immutable for the life of the Deck. The options include: Squib supports various configuration properties that can be specified in an external file. The `config:` option in `Deck.new` can specify an optional configuration file in YML format. The properties there are intended to be immutable for the life of the Deck. The options include: