aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAndre Weissflog <floooh@gmail.com>2020-11-02 11:40:29 +0100
committerAndre Weissflog <floooh@gmail.com>2020-11-02 11:40:29 +0100
commit8ee954f48616d92d2afd16b626cb4a7f3c9d54a1 (patch)
tree026920ea0b3ebaae5eac16cb61b3f6c727f4530c /README.md
parent612755ec6665ea71c84aa9ca8a6d2b53f9730293 (diff)
some readme updates
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/README.md b/README.md
index 4b408536..899827a3 100644
--- a/README.md
+++ b/README.md
@@ -12,7 +12,9 @@ cross-platform libraries for C and C++, written in C.
[LearnOpenGL examples ported to sokol-gfx](https://www.geertarien.com/learnopengl-examples-html5/) by @geertarien (cool stuff!)
-Cross-platform libraries:
+[Dear ImGui starterkit](https://github.com/floooh/cimgui-sokol-starterkit) a self-contained starterkit for writing Dear ImGui apps in C.
+
+## Core libraries
- [**sokol\_gfx.h**](https://github.com/floooh/sokol/blob/master/sokol_gfx.h): 3D-API wrapper (GL + Metal + D3D11)
- [**sokol\_app.h**](https://github.com/floooh/sokol/blob/master/sokol_app.h): app framework wrapper (entry + window + 3D-context + input)
@@ -21,7 +23,7 @@ Cross-platform libraries:
- [**sokol\_fetch.h**](https://github.com/floooh/sokol/blob/master/sokol_fetch.h): asynchronous data streaming from HTTP and local filesystem
- [**sokol\_args.h**](https://github.com/floooh/sokol/blob/master/sokol_args.h): unified cmdline/URL arg parser for web and native apps
-Utility libraries:
+## Utility libraries
- [**sokol\_imgui.h**](https://github.com/floooh/sokol/blob/master/util/sokol_imgui.h): sokol_gfx.h rendering backend for [Dear ImGui](https://github.com/ocornut/imgui)
- [**sokol\_gl.h**](https://github.com/floooh/sokol/blob/master/util/sokol_gl.h): OpenGL 1.x style immediate-mode rendering API on top of sokol_gfx.h
@@ -30,11 +32,13 @@ Utility libraries:
- [**sokol\_debugtext.h**](https://github.com/floooh/sokol/blob/master/util/sokol_debugtext.h): a simple text renderer using vintage home computer fonts
- [**sokol\_memtrack.h**](https://github.com/floooh/sokol/blob/master/util/sokol_memtrack.h): easily track memory allocations in sokol headers
+## Notes
+
WebAssembly is a 'first-class citizen', one important motivation for the
Sokol headers is to provide a collection of cross-platform APIs with a
minimal footprint on the web platform while still being useful.
-All headers are standalone and can be used independently from each other.
+The core headers are standalone and can be used independently from each other.
Sample code is in a separate repo: https://github.com/floooh/sokol-samples