Immediate-Mode-UI · RobLoach · Mar 26, 2026 · Mar 30, 2026
diff --git a/.Doxyfile b/.Doxyfile
@@ -53,7 +53,7 @@ PROJECT_NUMBER         =
 # for a project that appears at the top of each page and should give viewer a
 # quick idea about the purpose of the project. Keep the description short.
 
-PROJECT_BRIEF          = "This is a minimal-state, immediate-mode graphical user interface toolkit written in ANSI C and licensed under public domain. It was designed as a simple embeddable user interface for application and does not have any dependencies, a default render backend or OS window/input handling but instead provides a highly modular, library-based approach, with simple input state for input and draw commands describing primitive shapes as output. So instead of providing a layered library that tries to abstract over a number of platform and render backends, it focuses only on the actual UI."
+PROJECT_BRIEF          = "Minimal-state, immediate-mode graphical user interface toolkit written in ANSI C."
 
 # With the PROJECT_LOGO tag one can specify a logo or an icon that is included
 # in the documentation. The maximum height of the logo should not exceed 55
@@ -171,7 +171,7 @@ INLINE_INHERITED_MEMB  = NO
 # shortest path that makes the file name unique will be used
 # The default value is: YES.
 
-FULL_PATH_NAMES        = YES
+FULL_PATH_NAMES        = NO
 
 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
 # Stripping is only done if one of the specified strings matches the left-hand
@@ -633,7 +633,7 @@ SHOW_HEADERFILE        = YES
 # the files that are included by a file in the documentation of that file.
 # The default value is: YES.
 
-SHOW_INCLUDE_FILES     = YES
+SHOW_INCLUDE_FILES     = NO
 
 # If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each
 # grouped member an include statement to the documentation, telling the reader
@@ -755,14 +755,14 @@ MAX_INITIALIZER_LINES  = 30
 # list will mention the files that were used to generate the documentation.
 # The default value is: YES.
 
-SHOW_USED_FILES        = YES
+SHOW_USED_FILES        = NO
 
 # Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
 # will remove the Files entry from the Quick Index and from the Folder Tree View
 # (if specified).
 # The default value is: YES.
 
-SHOW_FILES             = YES
+SHOW_FILES             = NO
 
 # Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces
 # page. This will remove the Namespaces entry from the Quick Index and from the
@@ -906,8 +906,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  =    "./src" \
-                            "./src/HEADER.md"
+INPUT                  =    ./src README.md
 
 
 
@@ -998,9 +997,11 @@ RECURSIVE              = NO
 # Note that relative paths are relative to the directory from which doxygen is
 # run.
 
-EXCLUDE                = "./src/Readme.md" \
+EXCLUDE                =    "./src/README.md" \
                             "./src/paq.sh" \
-                            "./src/paq.bat"
+                            "./src/paq.bat" \
+                            "./src/stb_rect_pack.h" \
+                            "./src/stb_truetype.h"
 
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded
@@ -1109,7 +1110,7 @@ FILTER_SOURCE_PATTERNS =
 # (index.html). This can be useful if you have a project on for instance GitHub
 # and want to reuse the introduction page also for the doxygen output.
 
-USE_MDFILE_AS_MAINPAGE = src/HEADER.md
+USE_MDFILE_AS_MAINPAGE = README.md
 
 #---------------------------------------------------------------------------
 # Configuration options related to source browsing

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -0,0 +1,35 @@
+# Contributing
+
+## Reviewers guide
+
+When reviewing pull request there are common things a reviewer should keep
+in mind.
+
+Reviewing changes to `src/*` and `nuklear.h`:
+
+* Ensure C89 compatibility.
+* The code should work for several backends to an acceptable degree.
+* Check no other parts of `nuklear.h` are related to the PR and thus nothing is missing.
+* Recommend simple optimizations.
+  * Pass small structs by value instead of by pointer.
+  * Use local buffers over heap allocation when possible.
+* Check that the coding style is consistent with code around it.
+  * Variable/function name casing.
+  * Indentation.
+  * Curly bracket (`{}`) placement.
+* Ensure that the contributor has bumped the appropriate version in
+  [clib.json](https://github.com/Immediate-Mode-UI/Nuklear/blob/master/clib.json).
+* Have at least one other person review the changes before merging.
+
+Reviewing changes to `demo/*`, `example/*` and other files in the repo:
+
+* Focus on getting working code merged.
+  * We want to make it easy for people to get started with Nuklear, and any
+    `demo` and `example` improvements helps in this regard.
+* Use of newer C features, or even other languages is not discouraged.
+  * If another language is used, ensure that the build process is easy to figure out.
+* Messy or less efficient code can be merged so long as these outliers are pointed out
+  and easy to find.
+* Version shouldn't be bumped for these changes.
+* Changes that improves code to be more inline with `nuklear.h` are ofc always welcome.
+
diff --git a/LICENSE b/LICENSE
@@ -1,6 +1,7 @@
-------------------------------------------------------------------------------
+License
+
 This software is available under 2 licenses -- choose whichever you prefer.
-------------------------------------------------------------------------------
+
 ALTERNATIVE A - MIT License
 Copyright (c) 2017 Micha Mettke
 Permission is hereby granted, free of charge, to any person obtaining a copy of
@@ -18,7 +19,7 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 SOFTWARE.
-------------------------------------------------------------------------------
+
 ALTERNATIVE B - Public Domain (www.unlicense.org)
 This is free and unencumbered software released into the public domain.
 Anyone is free to copy, modify, publish, use, compile, sell, or distribute this
@@ -36,4 +37,3 @@ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
 WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
------------------------------------------------------------------------------
diff --git a/Makefile b/Makefile
@@ -17,17 +17,17 @@ DOXYFILE:=.Doxyfile
 ## note: source file paths are prefixed later, no need to add prefix here; just
 ## give it the name.
 MACRO = NK
-INTRO =  HEADER.md
+INTRO =  HEADER.h
 PUB = nuklear.h
 OUTPUT = nuklear.h
 
-PRIV1 = nuklear_internal.h nuklear_math.c nuklear_util.c nuklear_color.c nuklear_utf8.c nuklear_buffer.c nuklear_string.c nuklear_draw.c nuklear_vertex.c 
+PRIV1 = nuklear_internal.h nuklear_math.c nuklear_util.c nuklear_color.c nuklear_utf8.c nuklear_buffer.c nuklear_string.c nuklear_draw.c nuklear_vertex.c
 
-EXTERN =  stb_rect_pack.h stb_truetype.h 
+EXTERN =  stb_rect_pack.h stb_truetype.h
 
 PRIV2 = nuklear_font.c nuklear_input.c nuklear_style.c nuklear_context.c nuklear_pool.c nuklear_page_element.c nuklear_table.c nuklear_panel.c nuklear_window.c nuklear_popup.c nuklear_contextual.c nuklear_menu.c nuklear_layout.c nuklear_tree.c nuklear_group.c nuklear_list_view.c nuklear_widget.c nuklear_text.c nuklear_image.c nuklear_9slice.c nuklear_button.c nuklear_toggle.c nuklear_selectable.c nuklear_slider.c nuklear_knob.c nuklear_progress.c nuklear_scrollbar.c nuklear_text_editor.c nuklear_edit.c nuklear_property.c nuklear_chart.c nuklear_color_picker.c nuklear_combo.c nuklear_tooltip.c
 
-OUTRO = LICENSE CHANGELOG CREDITS
+OUTRO = ../LICENSE CHANGELOG CREDITS
 
 ## Demo settings
 DEMO_LIST = $(shell find $(DEMO_PATH) -type f -name Makefile -printf "%h ")
@@ -45,7 +45,7 @@ usage:
 	echo "make demos	to build all of the demos"
 	echo "make all 		to re-pack the header and create documentation"
 
-all: docs nuke demos 
+all: docs nuke demos
 demos: $(DEMO_LIST)
 
 
@@ -62,7 +62,7 @@ nuke: $(addprefix $(SRC_PATH)/, $(SRC))
 ########################################################################################
 ##   Docs
 
-docs: $(DOCS_PATH)/html/index.html 
+docs: $(DOCS_PATH)/html/index.html
 
 $(DOCS_PATH)/html/index.html: $(DOCS_PATH)/doxygen-awesome-css/doxygen-awesome.css $(DOXYFILE)
 	doxygen $(DOXYFILE)

diff --git a/Readme.md → README.md b/Readme.md → README.md
@@ -27,7 +27,7 @@ render backends, it focuses only on the actual UI.
 - Optional font baker and vertex buffer output
 - [Documentation](https://Immediate-Mode-UI.github.io/Nuklear/)
 
-## Building
+## Usage
 
 This library is self-contained in one single header file and can be used either
 in header-only mode or in implementation mode. The header-only mode is used
@@ -128,37 +128,3 @@ in libraries and brought me to create some of my own. Finally Apoorva Joshi for
 ## License
 Nuklear is avaliable under either the MIT License or public domain.
 See [LICENSE](LICENSE) for more info.
-
-## Reviewers guide
-
-When reviewing pull request there are common things a reviewer should keep
-in mind.
-
-Reviewing changes to `src/*` and `nuklear.h`:
-
-* Ensure C89 compatibility.
-* The code should work for several backends to an acceptable degree.
-* Check no other parts of `nuklear.h` are related to the PR and thus nothing is missing.
-* Recommend simple optimizations.
-  * Pass small structs by value instead of by pointer.
-  * Use local buffers over heap allocation when possible.
-* Check that the coding style is consistent with code around it.
-  * Variable/function name casing.
-  * Indentation.
-  * Curly bracket (`{}`) placement.
-* Ensure that the contributor has bumped the appropriate version in
-  [clib.json](https://github.com/Immediate-Mode-UI/Nuklear/blob/master/clib.json).
-* Have at least one other person review the changes before merging.
-
-Reviewing changes to `demo/*`, `example/*` and other files in the repo:
-
-* Focus on getting working code merged.
-  * We want to make it easy for people to get started with Nuklear, and any
-    `demo` and `example` improvements helps in this regard.
-* Use of newer C features, or even other languages is not discouraged.
-  * If another language is used, ensure that the build process is easy to figure out.
-* Messy or less efficient code can be merged so long as these outliers are pointed out
-  and easy to find.
-* Version shouldn't be bumped for these changes.
-* Changes that improves code to be more inline with `nuklear.h` are ofc always welcome.
-