2
0
mirror of https://github.com/koreader/koreader synced 2024-11-16 06:12:56 +00:00
koreader/doc/Hacking.md

25 lines
691 B
Markdown
Raw Normal View History

2016-02-18 05:05:07 +00:00
Hacking
=======
Developing UI Widgets
---------------------
2016-02-29 00:53:47 +00:00
`utils/wbuilder.lua` is your friend, if you need to create new UI widgets. It
2016-02-18 05:05:07 +00:00
sets up a minimal environment to bootstrap KOReader's UI framework to avoid
starting the whole reader. This gives you quick feedback loop while iterating
2016-02-29 00:53:47 +00:00
through your widget changes. It's also a handy tool for debugging widget
issues.
2016-02-18 05:05:07 +00:00
To get a taste of how it works, try running this command at the root of
KOReader's source tree:
```
./kodev wbuilder
```
It will spawn up an emulator window with a grid and simple timer widget for
demonstration.
2016-02-29 00:53:47 +00:00
You can add more `UIManager:show` call at the end of `utils/wbuilder.lua` to
test your new widgets.