Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
crysxd authored May 28, 2024
1 parent e58d407 commit f1115b9
Showing 1 changed file with 23 additions and 3 deletions.
26 changes: 23 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,31 @@ Features:
- Support for modes and variables in Figma
- Code generation using Jinja2 templating syntax for any code language
- Export of icons as SVG, PDF, PNG, WEBP or Android XML vectors
- Simple configuration
- Simple configuration with many options

```
{
"type": "values",
"templatePath": "../samples/AndroidValues.xml.figex",
"destinationPath": "~/Downloads/AndroidValuesModeB.xml",
"defaultMode": "modeB",
"templateVariables": {
"templateVarDemo": "\uD83D\uDE80\uD83D\uDE80\uD83D\uDE80"
}
},
{
"type": "icons",
"format": "androidxml",
"filter": "{% if fullName|startsWith('icon-', true) %} true {% else %} false {% endif %}",
"fileNames" : "{{ fullName|replaceSpecialChars('_')|lowercase }}",
"destinationPath": "~/Downloads/icons",
"clearDestination": true
}
```

## Installation

1. Download a release from the release list
1. Download a `figex.zip` from the [release list](https://github.com/iodigital-com/figex/releases)
2. Extract the zip file and place it in your system
3. Add the extracted directory to your system's `$PATH` (macOS)

Expand Down Expand Up @@ -141,4 +161,4 @@ Hint: You can also use Jinja filters to modify the name, e.g. `{{ color.name|low

- Clone the Git
- `./gradlew clean build` will build the project and create files
in `figma-exported/build/distributions`
in `figma-exported/build/distributions`

0 comments on commit f1115b9

Please sign in to comment.