mirrors/Nuklear
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
b6a7791d13
Nuklear/Readme.md

167 lines
7.4 KiB
Markdown
Raw Normal View History

Updated Readme
2017-02-24 21:18:27 +03:00
# Nuklear
Fix CI badge image
2019-12-20 01:29:07 +03:00
[![](https://github.com/Immediate-Mode-UI/Nuklear/workflows/C%2FC++%20CI/badge.svg )](https://github.com/Immediate-Mode-UI/Nuklear/actions)
add: preliminary support for GitHub CI/workflow build badge
2019-12-04 19:08:37 +03:00
Tidy up the README a little Some of the sentences in the README are pretty long and some terms could do with hyphens. Tidy this up. Signed-off-by: Simon Glass <sjg@chromium.org>
2019-10-25 19:15:13 +03:00
This is a minimal-state, immediate-mode graphical user interface toolkit
Release Version 1.0 This is the first release version of nuklear (previously: zahnrad). As for those who no the old version will notice: a lot has changed. Most obvious should be the two biggest changes. First the name change because I got critique that the name is hard to comprehend and remember (understandable for non-germans) and the second is the transistion from four files (zahnrad.h, zahnrad.c, stb_truetype and stb_rect_pack) to one single header library file nuklear.h. I am not 100% convinced that using a single header library is the right choice here but so far I haven't encountered any problems. Noticable should be as well that nuklear now directly embeds three stb libraries: stb_truetype, stb_rect_pack and stb_textedit. Like in previous versions the first two are optional and the library can be compiled without. stb_textedit on the other hand powers the text edit implementation for single as well as multiline text manipulation. The text edit implementation is still relative new and untested so you can expect some bugs I have not found yet. In the demo department a lot changed as well. All platform demos now don't compile one big demo but instead contain a simple demo and small abstraction layer over the platform. Main benefit is better understandablity improved ease of use. The old demo is now split up and transfered into the example folder while each part is self contained and compileable. (All examples use glfw I don't now if this is the best platform but it is at least the simplest. I also removed the apple demo because I don't have an apple system and cannot make sure the new version runs with the old version. Finally a lot of small bugs have been fixed as well as bugs found by clang analyzer and coverity.
2016-04-11 02:34:59 +03:00
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,
Tidy up the README a little Some of the sentences in the README are pretty long and some terms could do with hyphens. Tidy this up. Signed-off-by: Simon Glass <sjg@chromium.org>
2019-10-25 19:15:13 +03:00
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
transfered screenshots
2015-09-17 18:31:43 +03:00
layered library that tries to abstract over a number of platform and
Tidy up the README a little Some of the sentences in the README are pretty long and some terms could do with hyphens. Tidy this up. Signed-off-by: Simon Glass <sjg@chromium.org>
2019-10-25 19:15:13 +03:00
render backends, it focuses only on the actual UI.
rewrote command buffer
2015-03-11 16:00:59 +03:00
added spinner + command input
2015-03-14 19:05:30 +03:00
## Features
Updated Readme
2017-02-24 21:18:27 +03:00
Tidy up the README a little Some of the sentences in the README are pretty long and some terms could do with hyphens. Tidy this up. Signed-off-by: Simon Glass <sjg@chromium.org>
2019-10-25 19:15:13 +03:00
- Immediate-mode graphical user interface toolkit
- Single-header library
added spinner + command input
2015-03-14 19:05:30 +03:00
- Written in C89 (ANSI C)
corrected line count
2017-08-20 01:45:46 +03:00
- Small codebase (~18kLOC)
Finally fixed the oldest bug in this library For now month I failed to find out why text calculation was bugged for zahnrads own vertex buffer font. I finally found the problem and fixed it.
2016-01-26 16:52:00 +03:00
- Focus on portability, efficiency and simplicity
Release Version 1.0 This is the first release version of nuklear (previously: zahnrad). As for those who no the old version will notice: a lot has changed. Most obvious should be the two biggest changes. First the name change because I got critique that the name is hard to comprehend and remember (understandable for non-germans) and the second is the transistion from four files (zahnrad.h, zahnrad.c, stb_truetype and stb_rect_pack) to one single header library file nuklear.h. I am not 100% convinced that using a single header library is the right choice here but so far I haven't encountered any problems. Noticable should be as well that nuklear now directly embeds three stb libraries: stb_truetype, stb_rect_pack and stb_textedit. Like in previous versions the first two are optional and the library can be compiled without. stb_textedit on the other hand powers the text edit implementation for single as well as multiline text manipulation. The text edit implementation is still relative new and untested so you can expect some bugs I have not found yet. In the demo department a lot changed as well. All platform demos now don't compile one big demo but instead contain a simple demo and small abstraction layer over the platform. Main benefit is better understandablity improved ease of use. The old demo is now split up and transfered into the example folder while each part is self contained and compileable. (All examples use glfw I don't now if this is the best platform but it is at least the simplest. I also removed the apple demo because I don't have an apple system and cannot make sure the new version runs with the old version. Finally a lot of small bugs have been fixed as well as bugs found by clang analyzer and coverity.
2016-04-11 02:34:59 +03:00
- No dependencies (not even the standard library if not wanted)
Added skinning and extend customization Previous visual changes in the library were quite limited with some colors and some global properties. This commit changes all that and provides way more control over every widgets visual appearance. Changes include extended color selection, per widget properties and the possibility to use skinning. While the new API allows for a lot more control it is currently quite low level and needs a lot more testing and probably another higher level style API to make changes in code easier. I also had to remove the style modification code inside the demo and will probably first try to write another higher level API before adding it back in. This commit also include some breaking changes to existing code like the missing style stack API and some widget names changes due to added granularity granted by the rewritten style.
2016-03-26 18:05:19 +03:00
- Fully skinnable and customizable
Tidy up the README a little Some of the sentences in the README are pretty long and some terms could do with hyphens. Tidy this up. Signed-off-by: Simon Glass <sjg@chromium.org>
2019-10-25 19:15:13 +03:00
- Low memory footprint with total control of memory usage if needed / wanted
added opengl demo
2015-04-30 17:12:21 +03:00
- UTF-8 support
Release Version 1.0 This is the first release version of nuklear (previously: zahnrad). As for those who no the old version will notice: a lot has changed. Most obvious should be the two biggest changes. First the name change because I got critique that the name is hard to comprehend and remember (understandable for non-germans) and the second is the transistion from four files (zahnrad.h, zahnrad.c, stb_truetype and stb_rect_pack) to one single header library file nuklear.h. I am not 100% convinced that using a single header library is the right choice here but so far I haven't encountered any problems. Noticable should be as well that nuklear now directly embeds three stb libraries: stb_truetype, stb_rect_pack and stb_textedit. Like in previous versions the first two are optional and the library can be compiled without. stb_textedit on the other hand powers the text edit implementation for single as well as multiline text manipulation. The text edit implementation is still relative new and untested so you can expect some bugs I have not found yet. In the demo department a lot changed as well. All platform demos now don't compile one big demo but instead contain a simple demo and small abstraction layer over the platform. Main benefit is better understandablity improved ease of use. The old demo is now split up and transfered into the example folder while each part is self contained and compileable. (All examples use glfw I don't now if this is the best platform but it is at least the simplest. I also removed the apple demo because I don't have an apple system and cannot make sure the new version runs with the old version. Finally a lot of small bugs have been fixed as well as bugs found by clang analyzer and coverity.
2016-04-11 02:34:59 +03:00
- No global or hidden state
Fix some typos.
2016-04-19 11:23:33 +03:00
- Customizable library modules (you can compile and use only what you need)
Release Version 1.0 This is the first release version of nuklear (previously: zahnrad). As for those who no the old version will notice: a lot has changed. Most obvious should be the two biggest changes. First the name change because I got critique that the name is hard to comprehend and remember (understandable for non-germans) and the second is the transistion from four files (zahnrad.h, zahnrad.c, stb_truetype and stb_rect_pack) to one single header library file nuklear.h. I am not 100% convinced that using a single header library is the right choice here but so far I haven't encountered any problems. Noticable should be as well that nuklear now directly embeds three stb libraries: stb_truetype, stb_rect_pack and stb_textedit. Like in previous versions the first two are optional and the library can be compiled without. stb_textedit on the other hand powers the text edit implementation for single as well as multiline text manipulation. The text edit implementation is still relative new and untested so you can expect some bugs I have not found yet. In the demo department a lot changed as well. All platform demos now don't compile one big demo but instead contain a simple demo and small abstraction layer over the platform. Main benefit is better understandablity improved ease of use. The old demo is now split up and transfered into the example folder while each part is self contained and compileable. (All examples use glfw I don't now if this is the best platform but it is at least the simplest. I also removed the apple demo because I don't have an apple system and cannot make sure the new version runs with the old version. Finally a lot of small bugs have been fixed as well as bugs found by clang analyzer and coverity.
2016-04-11 02:34:59 +03:00
- Optional font baker and vertex buffer output
update for PR on original repo
2020-04-30 13:41:07 +03:00
- [Documentation](https://Immediate-Mode-UI.github.io/Nuklear/doc/nuklear.html)
updated Readme
2015-11-19 23:02:36 +03:00
## Building
Updated Readme
2017-02-24 21:18:27 +03:00
Tidy up the README a little Some of the sentences in the README are pretty long and some terms could do with hyphens. Tidy this up. Signed-off-by: Simon Glass <sjg@chromium.org>
2019-10-25 19:15:13 +03:00
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
Release Version 1.0 This is the first release version of nuklear (previously: zahnrad). As for those who no the old version will notice: a lot has changed. Most obvious should be the two biggest changes. First the name change because I got critique that the name is hard to comprehend and remember (understandable for non-germans) and the second is the transistion from four files (zahnrad.h, zahnrad.c, stb_truetype and stb_rect_pack) to one single header library file nuklear.h. I am not 100% convinced that using a single header library is the right choice here but so far I haven't encountered any problems. Noticable should be as well that nuklear now directly embeds three stb libraries: stb_truetype, stb_rect_pack and stb_textedit. Like in previous versions the first two are optional and the library can be compiled without. stb_textedit on the other hand powers the text edit implementation for single as well as multiline text manipulation. The text edit implementation is still relative new and untested so you can expect some bugs I have not found yet. In the demo department a lot changed as well. All platform demos now don't compile one big demo but instead contain a simple demo and small abstraction layer over the platform. Main benefit is better understandablity improved ease of use. The old demo is now split up and transfered into the example folder while each part is self contained and compileable. (All examples use glfw I don't now if this is the best platform but it is at least the simplest. I also removed the apple demo because I don't have an apple system and cannot make sure the new version runs with the old version. Finally a lot of small bugs have been fixed as well as bugs found by clang analyzer and coverity.
2016-04-11 02:34:59 +03:00
by default when included and allows including this header in other headers
and does not contain the actual implementation.
Tidy up the README a little Some of the sentences in the README are pretty long and some terms could do with hyphens. Tidy this up. Signed-off-by: Simon Glass <sjg@chromium.org>
2019-10-25 19:15:13 +03:00
The implementation mode requires defining the preprocessor macro
Update Readme.md Change PNG Badge to SVG and other tiny fixes
2016-05-02 15:44:22 +03:00
`NK_IMPLEMENTATION` in *one* .c/.cpp file before `#include`ing this file, e.g.:
Release Version 1.0 This is the first release version of nuklear (previously: zahnrad). As for those who no the old version will notice: a lot has changed. Most obvious should be the two biggest changes. First the name change because I got critique that the name is hard to comprehend and remember (understandable for non-germans) and the second is the transistion from four files (zahnrad.h, zahnrad.c, stb_truetype and stb_rect_pack) to one single header library file nuklear.h. I am not 100% convinced that using a single header library is the right choice here but so far I haven't encountered any problems. Noticable should be as well that nuklear now directly embeds three stb libraries: stb_truetype, stb_rect_pack and stb_textedit. Like in previous versions the first two are optional and the library can be compiled without. stb_textedit on the other hand powers the text edit implementation for single as well as multiline text manipulation. The text edit implementation is still relative new and untested so you can expect some bugs I have not found yet. In the demo department a lot changed as well. All platform demos now don't compile one big demo but instead contain a simple demo and small abstraction layer over the platform. Main benefit is better understandablity improved ease of use. The old demo is now split up and transfered into the example folder while each part is self contained and compileable. (All examples use glfw I don't now if this is the best platform but it is at least the simplest. I also removed the apple demo because I don't have an apple system and cannot make sure the new version runs with the old version. Finally a lot of small bugs have been fixed as well as bugs found by clang analyzer and coverity.
2016-04-11 02:34:59 +03:00
```c
Update Readme.md Change PNG Badge to SVG and other tiny fixes
2016-05-02 15:44:22 +03:00
#define NK_IMPLEMENTATION
#include "nuklear.h"
Release Version 1.0 This is the first release version of nuklear (previously: zahnrad). As for those who no the old version will notice: a lot has changed. Most obvious should be the two biggest changes. First the name change because I got critique that the name is hard to comprehend and remember (understandable for non-germans) and the second is the transistion from four files (zahnrad.h, zahnrad.c, stb_truetype and stb_rect_pack) to one single header library file nuklear.h. I am not 100% convinced that using a single header library is the right choice here but so far I haven't encountered any problems. Noticable should be as well that nuklear now directly embeds three stb libraries: stb_truetype, stb_rect_pack and stb_textedit. Like in previous versions the first two are optional and the library can be compiled without. stb_textedit on the other hand powers the text edit implementation for single as well as multiline text manipulation. The text edit implementation is still relative new and untested so you can expect some bugs I have not found yet. In the demo department a lot changed as well. All platform demos now don't compile one big demo but instead contain a simple demo and small abstraction layer over the platform. Main benefit is better understandablity improved ease of use. The old demo is now split up and transfered into the example folder while each part is self contained and compileable. (All examples use glfw I don't now if this is the best platform but it is at least the simplest. I also removed the apple demo because I don't have an apple system and cannot make sure the new version runs with the old version. Finally a lot of small bugs have been fixed as well as bugs found by clang analyzer and coverity.
2016-04-11 02:34:59 +03:00
```
Added documentation to warn for #233 Since it was not as apparent as I thought it is I added some documentation warning to set the same flags each time you include "nuklear.h" except `NK_IMPLEMENTATION` which is only allowed to be defined once in *one* source file.
2016-09-04 21:46:23 +03:00
IMPORTANT: Every time you include "nuklear.h" you have to define the same optional flags.
Tidy up the README a little Some of the sentences in the README are pretty long and some terms could do with hyphens. Tidy this up. Signed-off-by: Simon Glass <sjg@chromium.org>
2019-10-25 19:15:13 +03:00
This is very important; not doing it either leads to compiler errors, or even worse, stack corruptions.
transfered screenshots
2015-09-17 18:31:43 +03:00
added addition screenshot
2015-05-09 16:22:23 +03:00
## Gallery
Updated Readme
2017-02-24 21:18:27 +03:00
updated Readme
2015-12-12 13:53:15 +03:00
![screenshot](https://cloud.githubusercontent.com/assets/8057201/11761525/ae06f0ca-a0c6-11e5-819d-5610b25f6ef4.gif)
updated readme
2016-03-04 22:46:45 +03:00
![screen](https://cloud.githubusercontent.com/assets/8057201/13538240/acd96876-e249-11e5-9547-5ac0b19667a0.png)
![screen2](https://cloud.githubusercontent.com/assets/8057201/13538243/b04acd4c-e249-11e5-8fd2-ad7744a5b446.png)
updated readme
2015-09-19 18:59:10 +03:00
![node](https://cloud.githubusercontent.com/assets/8057201/9976995/e81ac04a-5ef7-11e5-872b-acd54fbeee03.gif)
Updated Readme
2016-06-12 17:14:24 +03:00
![skinning](https://cloud.githubusercontent.com/assets/8057201/15991632/76494854-30b8-11e6-9555-a69840d0d50b.png)
Updated Readme
2016-04-29 00:54:13 +03:00
![gamepad](https://cloud.githubusercontent.com/assets/8057201/14902576/339926a8-0d9c-11e6-9fee-a8b73af04473.png)
added addition screenshot
2015-05-09 16:22:23 +03:00
updated Readme and added screenshot
2015-04-25 17:44:43 +03:00
## Example
Updated Readme
2017-02-24 21:18:27 +03:00
updated Readme and added screenshot
2015-04-25 17:44:43 +03:00
```c
massive rewrite
2015-12-30 18:31:08 +03:00
/* init gui state */
Release Version 1.0 This is the first release version of nuklear (previously: zahnrad). As for those who no the old version will notice: a lot has changed. Most obvious should be the two biggest changes. First the name change because I got critique that the name is hard to comprehend and remember (understandable for non-germans) and the second is the transistion from four files (zahnrad.h, zahnrad.c, stb_truetype and stb_rect_pack) to one single header library file nuklear.h. I am not 100% convinced that using a single header library is the right choice here but so far I haven't encountered any problems. Noticable should be as well that nuklear now directly embeds three stb libraries: stb_truetype, stb_rect_pack and stb_textedit. Like in previous versions the first two are optional and the library can be compiled without. stb_textedit on the other hand powers the text edit implementation for single as well as multiline text manipulation. The text edit implementation is still relative new and untested so you can expect some bugs I have not found yet. In the demo department a lot changed as well. All platform demos now don't compile one big demo but instead contain a simple demo and small abstraction layer over the platform. Main benefit is better understandablity improved ease of use. The old demo is now split up and transfered into the example folder while each part is self contained and compileable. (All examples use glfw I don't now if this is the best platform but it is at least the simplest. I also removed the apple demo because I don't have an apple system and cannot make sure the new version runs with the old version. Finally a lot of small bugs have been fixed as well as bugs found by clang analyzer and coverity.
2016-04-11 02:34:59 +03:00
struct nk_context ctx;
nk_init_fixed(&ctx, calloc(1, MAX_MEMORY), MAX_MEMORY, &font);
massive rewrite
2015-12-30 18:31:08 +03:00
added float spinner + rewrote panel row layout API
2015-08-05 13:48:01 +03:00
enum {EASY, HARD};
Made properties static or they can't be changed
2017-03-17 22:24:28 +03:00
static int op = EASY;
static float value = 0.6f;
static int i = 20;
massive rewrite
2015-12-30 18:31:08 +03:00
Pulled panel memory managment into nuklear I simplified a lot of API calls by pulling panel memory management inside the library. All API calls which previously required a panel as parameter are now handling their panel themself.
2016-10-30 00:23:46 +03:00
if (nk_begin(&ctx, "Show", nk_rect(50, 50, 220, 220),
update example to recent api changes
2016-09-18 03:31:45 +03:00
NK_WINDOW_BORDER|NK_WINDOW_MOVABLE|NK_WINDOW_CLOSABLE)) {
updated demo and fixed some small bugs
2016-01-04 23:34:48 +03:00
/* fixed widget pixel width */
Release Version 1.0 This is the first release version of nuklear (previously: zahnrad). As for those who no the old version will notice: a lot has changed. Most obvious should be the two biggest changes. First the name change because I got critique that the name is hard to comprehend and remember (understandable for non-germans) and the second is the transistion from four files (zahnrad.h, zahnrad.c, stb_truetype and stb_rect_pack) to one single header library file nuklear.h. I am not 100% convinced that using a single header library is the right choice here but so far I haven't encountered any problems. Noticable should be as well that nuklear now directly embeds three stb libraries: stb_truetype, stb_rect_pack and stb_textedit. Like in previous versions the first two are optional and the library can be compiled without. stb_textedit on the other hand powers the text edit implementation for single as well as multiline text manipulation. The text edit implementation is still relative new and untested so you can expect some bugs I have not found yet. In the demo department a lot changed as well. All platform demos now don't compile one big demo but instead contain a simple demo and small abstraction layer over the platform. Main benefit is better understandablity improved ease of use. The old demo is now split up and transfered into the example folder while each part is self contained and compileable. (All examples use glfw I don't now if this is the best platform but it is at least the simplest. I also removed the apple demo because I don't have an apple system and cannot make sure the new version runs with the old version. Finally a lot of small bugs have been fixed as well as bugs found by clang analyzer and coverity.
2016-04-11 02:34:59 +03:00
nk_layout_row_static(&ctx, 30, 80, 1);
update example to recent api changes
2016-09-18 03:31:45 +03:00
if (nk_button_label(&ctx, "button")) {
updated demo and fixed some small bugs
2016-01-04 23:34:48 +03:00
/* event handling */
massive rewrite
2015-12-30 18:31:08 +03:00
}
updated Readme
2015-06-28 11:09:53 +03:00
updated demo and fixed some small bugs
2016-01-04 23:34:48 +03:00
/* fixed widget window ratio width */
Release Version 1.0 This is the first release version of nuklear (previously: zahnrad). As for those who no the old version will notice: a lot has changed. Most obvious should be the two biggest changes. First the name change because I got critique that the name is hard to comprehend and remember (understandable for non-germans) and the second is the transistion from four files (zahnrad.h, zahnrad.c, stb_truetype and stb_rect_pack) to one single header library file nuklear.h. I am not 100% convinced that using a single header library is the right choice here but so far I haven't encountered any problems. Noticable should be as well that nuklear now directly embeds three stb libraries: stb_truetype, stb_rect_pack and stb_textedit. Like in previous versions the first two are optional and the library can be compiled without. stb_textedit on the other hand powers the text edit implementation for single as well as multiline text manipulation. The text edit implementation is still relative new and untested so you can expect some bugs I have not found yet. In the demo department a lot changed as well. All platform demos now don't compile one big demo but instead contain a simple demo and small abstraction layer over the platform. Main benefit is better understandablity improved ease of use. The old demo is now split up and transfered into the example folder while each part is self contained and compileable. (All examples use glfw I don't now if this is the best platform but it is at least the simplest. I also removed the apple demo because I don't have an apple system and cannot make sure the new version runs with the old version. Finally a lot of small bugs have been fixed as well as bugs found by clang analyzer and coverity.
2016-04-11 02:34:59 +03:00
nk_layout_row_dynamic(&ctx, 30, 2);
update example to recent api changes
2016-09-18 03:31:45 +03:00
if (nk_option_label(&ctx, "easy", op == EASY)) op = EASY;
if (nk_option_label(&ctx, "hard", op == HARD)) op = HARD;
updated demo and fixed some small bugs
2016-01-04 23:34:48 +03:00
/* custom widget pixel width */
Release Version 1.0 This is the first release version of nuklear (previously: zahnrad). As for those who no the old version will notice: a lot has changed. Most obvious should be the two biggest changes. First the name change because I got critique that the name is hard to comprehend and remember (understandable for non-germans) and the second is the transistion from four files (zahnrad.h, zahnrad.c, stb_truetype and stb_rect_pack) to one single header library file nuklear.h. I am not 100% convinced that using a single header library is the right choice here but so far I haven't encountered any problems. Noticable should be as well that nuklear now directly embeds three stb libraries: stb_truetype, stb_rect_pack and stb_textedit. Like in previous versions the first two are optional and the library can be compiled without. stb_textedit on the other hand powers the text edit implementation for single as well as multiline text manipulation. The text edit implementation is still relative new and untested so you can expect some bugs I have not found yet. In the demo department a lot changed as well. All platform demos now don't compile one big demo but instead contain a simple demo and small abstraction layer over the platform. Main benefit is better understandablity improved ease of use. The old demo is now split up and transfered into the example folder while each part is self contained and compileable. (All examples use glfw I don't now if this is the best platform but it is at least the simplest. I also removed the apple demo because I don't have an apple system and cannot make sure the new version runs with the old version. Finally a lot of small bugs have been fixed as well as bugs found by clang analyzer and coverity.
2016-04-11 02:34:59 +03:00
nk_layout_row_begin(&ctx, NK_STATIC, 30, 2);
updated demo and fixed some small bugs
2016-01-04 23:34:48 +03:00
{
Release Version 1.0 This is the first release version of nuklear (previously: zahnrad). As for those who no the old version will notice: a lot has changed. Most obvious should be the two biggest changes. First the name change because I got critique that the name is hard to comprehend and remember (understandable for non-germans) and the second is the transistion from four files (zahnrad.h, zahnrad.c, stb_truetype and stb_rect_pack) to one single header library file nuklear.h. I am not 100% convinced that using a single header library is the right choice here but so far I haven't encountered any problems. Noticable should be as well that nuklear now directly embeds three stb libraries: stb_truetype, stb_rect_pack and stb_textedit. Like in previous versions the first two are optional and the library can be compiled without. stb_textedit on the other hand powers the text edit implementation for single as well as multiline text manipulation. The text edit implementation is still relative new and untested so you can expect some bugs I have not found yet. In the demo department a lot changed as well. All platform demos now don't compile one big demo but instead contain a simple demo and small abstraction layer over the platform. Main benefit is better understandablity improved ease of use. The old demo is now split up and transfered into the example folder while each part is self contained and compileable. (All examples use glfw I don't now if this is the best platform but it is at least the simplest. I also removed the apple demo because I don't have an apple system and cannot make sure the new version runs with the old version. Finally a lot of small bugs have been fixed as well as bugs found by clang analyzer and coverity.
2016-04-11 02:34:59 +03:00
nk_layout_row_push(&ctx, 50);
nk_label(&ctx, "Volume:", NK_TEXT_LEFT);
nk_layout_row_push(&ctx, 110);
nk_slider_float(&ctx, 0, &value, 1.0f, 0.1f);
updated Readme and added screenshot
2015-04-25 17:44:43 +03:00
}
Release Version 1.0 This is the first release version of nuklear (previously: zahnrad). As for those who no the old version will notice: a lot has changed. Most obvious should be the two biggest changes. First the name change because I got critique that the name is hard to comprehend and remember (understandable for non-germans) and the second is the transistion from four files (zahnrad.h, zahnrad.c, stb_truetype and stb_rect_pack) to one single header library file nuklear.h. I am not 100% convinced that using a single header library is the right choice here but so far I haven't encountered any problems. Noticable should be as well that nuklear now directly embeds three stb libraries: stb_truetype, stb_rect_pack and stb_textedit. Like in previous versions the first two are optional and the library can be compiled without. stb_textedit on the other hand powers the text edit implementation for single as well as multiline text manipulation. The text edit implementation is still relative new and untested so you can expect some bugs I have not found yet. In the demo department a lot changed as well. All platform demos now don't compile one big demo but instead contain a simple demo and small abstraction layer over the platform. Main benefit is better understandablity improved ease of use. The old demo is now split up and transfered into the example folder while each part is self contained and compileable. (All examples use glfw I don't now if this is the best platform but it is at least the simplest. I also removed the apple demo because I don't have an apple system and cannot make sure the new version runs with the old version. Finally a lot of small bugs have been fixed as well as bugs found by clang analyzer and coverity.
2016-04-11 02:34:59 +03:00
nk_layout_row_end(&ctx);
updated Readme and added screenshot
2015-04-25 17:44:43 +03:00
}
update example to recent api changes
2016-09-18 03:31:45 +03:00
nk_end(&ctx);
updated Readme and added screenshot
2015-04-25 17:44:43 +03:00
```
updated Readme
2015-09-30 11:23:45 +03:00
![example](https://cloud.githubusercontent.com/assets/8057201/10187981/584ecd68-675c-11e5-897c-822ef534a876.png)
updated Readme and added screenshot
2015-04-25 17:44:43 +03:00
Updated Readme
2017-02-24 21:18:27 +03:00
## Bindings
Fix various typos Found via `codespell -q 3 -L acount,modifyable,nd,pixelx,seperator,te,vertexes`
2021-12-01 05:45:48 +03:00
There are a number of nuklear bindings for different languages created by other authors.
Tidy up the README a little Some of the sentences in the README are pretty long and some terms could do with hyphens. Tidy this up. Signed-off-by: Simon Glass <sjg@chromium.org>
2019-10-25 19:15:13 +03:00
I cannot attest for their quality since I am not necessarily proficient in any of these
Updated Readme
2017-02-24 21:18:27 +03:00
languages. Furthermore there are no guarantee that all bindings will always be kept up to date:
Updated Readme
2016-05-17 19:37:13 +03:00
Updated Readme
2017-02-24 21:18:27 +03:00
- [Java](https://github.com/glegris/nuklear4j) by Guillaume Legris
Update Readme.md Fix author name
2019-06-07 01:06:01 +03:00
- [D](https://github.com/Timu5/bindbc-nuklear) by Mateusz Muszyński
Updated Readme
2017-02-24 21:18:27 +03:00
- [Golang](https://github.com/golang-ui/nuklear) by golang-ui@github.com
- [Rust](https://github.com/snuk182/nuklear-rust) by snuk182@github.com
Add C# binding to the list
2018-01-09 07:52:18 +03:00
- [Chicken](https://github.com/wasamasa/nuklear) by wasamasa@github.com
Updated Readme
2017-02-24 21:18:27 +03:00
- [Nim](https://github.com/zacharycarter/nuklear-nim) by zacharycarter@github.com
Add reference to MoonNuklear (Lua) Added reference to MoonNuklear Fixed Lua/Löve2d library name
2018-04-12 19:48:53 +03:00
- Lua
- [LÖVE-Nuklear](https://github.com/keharriso/love-nuklear) by Kevin Harrison
- [MoonNuklear](https://github.com/stetre/moonnuklear) by Stefano Trettel
Add reference to pynk
2018-03-24 20:20:26 +03:00
- Python
- [pyNuklear](https://github.com/billsix/pyNuklear) by William Emerison Six (ctypes-based wrapper)
- [pynk](https://github.com/nathanrw/nuklear-cffi) by nathanrw@github.com (cffi binding)
Update Readme.md
2018-01-09 07:55:25 +03:00
- [CSharp/.NET](https://github.com/cartman300/NuklearDotNet) by cartman300@github.com
Add V binding
2020-02-23 02:32:08 +03:00
- [V](https://github.com/nsauzede/vnk) by Nicolas Sauzede
Updated Readme
2017-02-24 21:18:27 +03:00
## Credits
Release Version 1.0 This is the first release version of nuklear (previously: zahnrad). As for those who no the old version will notice: a lot has changed. Most obvious should be the two biggest changes. First the name change because I got critique that the name is hard to comprehend and remember (understandable for non-germans) and the second is the transistion from four files (zahnrad.h, zahnrad.c, stb_truetype and stb_rect_pack) to one single header library file nuklear.h. I am not 100% convinced that using a single header library is the right choice here but so far I haven't encountered any problems. Noticable should be as well that nuklear now directly embeds three stb libraries: stb_truetype, stb_rect_pack and stb_textedit. Like in previous versions the first two are optional and the library can be compiled without. stb_textedit on the other hand powers the text edit implementation for single as well as multiline text manipulation. The text edit implementation is still relative new and untested so you can expect some bugs I have not found yet. In the demo department a lot changed as well. All platform demos now don't compile one big demo but instead contain a simple demo and small abstraction layer over the platform. Main benefit is better understandablity improved ease of use. The old demo is now split up and transfered into the example folder while each part is self contained and compileable. (All examples use glfw I don't now if this is the best platform but it is at least the simplest. I also removed the apple demo because I don't have an apple system and cannot make sure the new version runs with the old version. Finally a lot of small bugs have been fixed as well as bugs found by clang analyzer and coverity.
2016-04-11 02:34:59 +03:00
Developed by Micha Mettke and every direct or indirect contributor to the GitHub.
Fix typos in README
2018-02-11 14:28:19 +03:00
Embeds `stb_texedit`, `stb_truetype` and `stb_rectpack` by Sean Barrett (public domain)
Update Readme.md Change PNG Badge to SVG and other tiny fixes
2016-05-02 15:44:22 +03:00
Embeds `ProggyClean.ttf` font by Tristan Grimmer (MIT license).
Release Version 1.0 This is the first release version of nuklear (previously: zahnrad). As for those who no the old version will notice: a lot has changed. Most obvious should be the two biggest changes. First the name change because I got critique that the name is hard to comprehend and remember (understandable for non-germans) and the second is the transistion from four files (zahnrad.h, zahnrad.c, stb_truetype and stb_rect_pack) to one single header library file nuklear.h. I am not 100% convinced that using a single header library is the right choice here but so far I haven't encountered any problems. Noticable should be as well that nuklear now directly embeds three stb libraries: stb_truetype, stb_rect_pack and stb_textedit. Like in previous versions the first two are optional and the library can be compiled without. stb_textedit on the other hand powers the text edit implementation for single as well as multiline text manipulation. The text edit implementation is still relative new and untested so you can expect some bugs I have not found yet. In the demo department a lot changed as well. All platform demos now don't compile one big demo but instead contain a simple demo and small abstraction layer over the platform. Main benefit is better understandablity improved ease of use. The old demo is now split up and transfered into the example folder while each part is self contained and compileable. (All examples use glfw I don't now if this is the best platform but it is at least the simplest. I also removed the apple demo because I don't have an apple system and cannot make sure the new version runs with the old version. Finally a lot of small bugs have been fixed as well as bugs found by clang analyzer and coverity.
2016-04-11 02:34:59 +03:00
Updated Readme
2016-04-29 00:54:13 +03:00
Big thank you to Omar Cornut (ocornut@github) for his [imgui](https://github.com/ocornut/imgui) library and
Release Version 1.0 This is the first release version of nuklear (previously: zahnrad). As for those who no the old version will notice: a lot has changed. Most obvious should be the two biggest changes. First the name change because I got critique that the name is hard to comprehend and remember (understandable for non-germans) and the second is the transistion from four files (zahnrad.h, zahnrad.c, stb_truetype and stb_rect_pack) to one single header library file nuklear.h. I am not 100% convinced that using a single header library is the right choice here but so far I haven't encountered any problems. Noticable should be as well that nuklear now directly embeds three stb libraries: stb_truetype, stb_rect_pack and stb_textedit. Like in previous versions the first two are optional and the library can be compiled without. stb_textedit on the other hand powers the text edit implementation for single as well as multiline text manipulation. The text edit implementation is still relative new and untested so you can expect some bugs I have not found yet. In the demo department a lot changed as well. All platform demos now don't compile one big demo but instead contain a simple demo and small abstraction layer over the platform. Main benefit is better understandablity improved ease of use. The old demo is now split up and transfered into the example folder while each part is self contained and compileable. (All examples use glfw I don't now if this is the best platform but it is at least the simplest. I also removed the apple demo because I don't have an apple system and cannot make sure the new version runs with the old version. Finally a lot of small bugs have been fixed as well as bugs found by clang analyzer and coverity.
2016-04-11 02:34:59 +03:00
giving me the inspiration for this library, Casey Muratori for handmade hero
Tidy up the README a little Some of the sentences in the README are pretty long and some terms could do with hyphens. Tidy this up. Signed-off-by: Simon Glass <sjg@chromium.org>
2019-10-25 19:15:13 +03:00
and his original immediate-mode graphical user interface idea and Sean
Barrett for his amazing single-header [libraries](https://github.com/nothings/stb) which restored my faith
Added out of the box windows support for packing the file
2019-12-04 18:41:37 +03:00
in libraries and brought me to create some of my own. Finally Apoorva Joshi for his single-header [file packer](http://apoorvaj.io/single-header-packer.html).
Release Version 1.0 This is the first release version of nuklear (previously: zahnrad). As for those who no the old version will notice: a lot has changed. Most obvious should be the two biggest changes. First the name change because I got critique that the name is hard to comprehend and remember (understandable for non-germans) and the second is the transistion from four files (zahnrad.h, zahnrad.c, stb_truetype and stb_rect_pack) to one single header library file nuklear.h. I am not 100% convinced that using a single header library is the right choice here but so far I haven't encountered any problems. Noticable should be as well that nuklear now directly embeds three stb libraries: stb_truetype, stb_rect_pack and stb_textedit. Like in previous versions the first two are optional and the library can be compiled without. stb_textedit on the other hand powers the text edit implementation for single as well as multiline text manipulation. The text edit implementation is still relative new and untested so you can expect some bugs I have not found yet. In the demo department a lot changed as well. All platform demos now don't compile one big demo but instead contain a simple demo and small abstraction layer over the platform. Main benefit is better understandablity improved ease of use. The old demo is now split up and transfered into the example folder while each part is self contained and compileable. (All examples use glfw I don't now if this is the best platform but it is at least the simplest. I also removed the apple demo because I don't have an apple system and cannot make sure the new version runs with the old version. Finally a lot of small bugs have been fixed as well as bugs found by clang analyzer and coverity.
2016-04-11 02:34:59 +03:00
Updated Readme
2017-02-24 21:18:27 +03:00
## License
Move copyright info to its own file (#667) * Create LICENSE * replace license with link to license
2024-08-26 18:29:47 +03:00
Nuklear is avaliable under either the MIT License or public domain.
See [LICENSE](LICENSE) for more info.
Add reviewers guide to readme (#72) Add reviewers guide to Readme.md
2020-03-08 22:19:30 +03:00
## 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.
readme.md: reviewer's guide: check for PR completeness (i.e. nothing is missing)
2020-03-31 15:52:08 +03:00
* Check no other parts of `nuklear.h` are related to the PR and thus nothing is missing.
Add reviewers guide to readme (#72) Add reviewers guide to Readme.md
2020-03-08 22:19:30 +03:00
* 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.
Fix various typos Found via `codespell -q 3 -L acount,modifyable,nd,pixelx,seperator,te,vertexes`
2021-12-01 05:45:48 +03:00
* Ensure that the contributor has bumped the appropriate version in
Rename package.json to clib.json (#365) The clib package manager has deprecated package.json in favor of clib.json (probably to reduce confusion between clib and other package managers). As far as I can tell, there's no difference in file format, just file name. * Remove version bump * Fix spelling of contributor Co-authored-by: Rob Loach <robloach@gmail.com>
2021-12-15 02:36:03 +03:00
[clib.json](https://github.com/Immediate-Mode-UI/Nuklear/blob/master/clib.json)
Add reviewers guide to readme (#72) Add reviewers guide to Readme.md
2020-03-08 22:19:30 +03:00
and added their changes to the
[CHANGELOG](https://github.com/Immediate-Mode-UI/Nuklear/blob/master/src/CHANGELOG).
* 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.
Reference in New Issue Copy Permalink