Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
kisvegabor authored Jan 9, 2025
1 parent 873bf1d commit b3dbe88
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,15 +25,16 @@ We believe designers should work freely in tools like Figma, focusing on creativ

1. **Install Docker**: Docker is required to compile your code and integrate it into the editor. Find the Docker installation guide [here](https://docs.docker.com/engine/install/).
2. **Download and install the Editor.** Find the installers [here](https://github.com/lvgl/lvgl_editor/releases/tag/v0.1.0).
3. **Fork and clone this repository** to experiment with its CI actions and online preview features.
3. **Fork and clone this repository** to experiment with its CI actions and online preview features. In the repository settings allow running `Actions` and set the source of `Pages` to `GitHub Action`.
4. **Open the editor** and load the example folder.
5. **Compile the project** to generate the custom C code in the editor’s preview (use the button in the top-right corner).
6. **Edit components**: Open `button_default.xml` and make edits. Save the file (Ctrl+S) to update the preview.
7. **Edit a widget**: Open `slider_box.xml` (a widget) and click "Compile Code." It will compile the C code alongside the widget's XML. Feel free to edit the C code and recompile it.
8. **Open the [Figma project](https://www.figma.com/design/itmQpC9m5HessaOZFbYTwK/Example?node-id=0-1&t=oWqPUdcRyVYtRgAY-0)** and duplicate it.
9. **Play with Figma**: Modify the Figma design and use the plugin to update style properties of the components.
10. **Try the online preview**: Commit and push your changes. Wait for the CI to run and check the online preview.
11. **Open an issue** if you encounter problems or get stuck. 😊
8. **Ckeck out Fonts and Images**: Open `globals.xml` to see how images and fonts are handled.
9. **Open the [Figma project](https://www.figma.com/design/itmQpC9m5HessaOZFbYTwK/Example?node-id=0-1&t=oWqPUdcRyVYtRgAY-0)** and duplicate it.
10. **Use the Figma to LVGL plugin**: Open our plugin, modify the design, and update the XMLs with the new styles.
11. **Try the online preview**: Commit and push your changes. Wait for the CI to run and check the online preview.
12. **Open an issue** if you encounter problems or get stuck. 😊

## Current Status and Future Plans

Expand Down

0 comments on commit b3dbe88

Please sign in to comment.