No examples

[thatrandomperson5]

This library seems really cool! But I have absolutely no clue how to use it and the tests + readme give conflicting info. Can you make an a examples dir with some basic running examples?

Just found the examples repo, but it is extremely confusing

[oakes]

Not sure if you noticed the starter project, I linked to it in the readme.

[dlesnoff]

I try to follow the README.md documentation step by step but I am really confused on where code snippets should be inserted in the starter project.

I have rewritten common.nim from scratch with elements from the documentation and just the necessary for the tui.nim file to work and output the hello_world.nim.

I inserted the render line in the tick procedure in the tui.nim file and could get one working example. The problem is that it would only work for the tui.nim file. I want the application to work also for the gui version, but I do not know what to do from the ctx parameter. Where is it defined exactly? It seems to be defined nowhere in the gui example.

Where do I call this render function? The documentation omits it!

I have kept a copy of the common.nim file in a common.bak.nim to fetch the necessary functions but I am still lost looking at the file. The common.platform variable does not seem to be used.

I have a weird type mismatch with all ctx.tb[0, 0] lines in the documentation, I do not know how to solve this.
What is ctx.tb?

I am not used to GUI/TUI development but the documentation should help me to understand the general principles of the library.

A smaller working example would help. I do not care about creating a window or a web version, if my CLI program does not work.
Why are so much low level details exposed to the user developer?
Could we import default onMouse, init, tick, onChar and onKey functions in common.nim and just focus on the ui elements in a first step?

[oakes]

The ctx.tb is the TerminalBuffer, which is the grid of characters that is rendered to your screen. Normally render is what fills it with content, but you can optionally modify individual cells using ctx.tb[0, 0] = ... if you want. If you're getting a type mismatch error when trying that, it's because you need to put this at the top of your file:

from illwave as iw import `[]`, `[]=`, `==`

You can optionally just put import illwave to make it import everything, but I don't like doing that.

There are definitely a lot of low level details exposed to you here, and that is intentional. Nimwave was extracted from ansiwave which needs access to those details. Buena suerte, amigo.

[sgmihai]

I also encountered the same problem, the starter project is way too large to figure out. Simple more atomic examples should be made, like the ones in the readme, showcasing the features and ways to build a tui with this lib.