github-migration/svggvs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

readme updates

Browse Source
This commit is contained in:
John Bintz 2013-11-17 13:02:20 -05:00
parent 991296bdbf
commit 7c7f50515f
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -14,6 +14,20 @@ is the name of the directory to place the skeleton project files. You'll get a f
## How it works ## How it works
Create an Inkscape SVG file in your project directory. Make sure it has a Source and a Target layer.
Your card template is made up of sublayers in the Source layer. These layers are copied to the Target layer
upon processing. The names of the layers are what you refer to in the `#active_layers` method in your `Cardfile`.
By default, layers are hidden, and hidden layers are deleted after copying to the Target layer,
unless they have the following names:
* (visible): The layer is always visible, regardless if it's specified in `#active_layers`
* (protect): The layer will not be deleted if it is hidden. Good for clone sources.
Hiding/showing layers is the way that you make certain card elements appear/disappear on
different types of cards with with different properties. You can also replace the text in
text boxes (both standard and flowroot boxes) by giving those boxes a distinct label (under Object Properties)
and feeding in a hash of label/text pairs into the `#replacements` method in the `Cardfile`.
Create a `Cardfile` in your working directory. It should look Create a `Cardfile` in your working directory. It should look
something like this: something like this: