Immediate-Mode-UI / Immediate-Mode-UI/Nuklear

THE example on the documentation page can't be compiled

Open
#977 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
C
Stars
11.4k
Forks
686
Avg merge
4d 1h
Merged PRs (30d)
3

Description

The documentation page
https://immediate-mode-ui.github.io/Nuklear/
contains ONE prominent example, following directly after the gallery of screenshots.

I could not compile it. There is no command that shows how to compile it, so I reused what I found in the Makefile of the examples folder and adapted it. I just got a lot of error messages.
Starting with one prominent (the one) example on the documentation page and not getting a running example is rather discouraging.

I tried other examples from the examples-folder and had to tweak things there also, to get something that runs and makes sense.

Please fix the one example (or replace it with a working one) and add a line that can be used to compile the code.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the prominent example on the Nuklear documentation page and compare it with the compilation commands in the examples folder's Makefile. Verify the example builds and runs, then document a usable compile command on the page; done means a newcomer can compile the featured example without additional tweaks.

Written by the indexing model from the issue text.

Assessment

Tech stack
c
Domain
build-system, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.