aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorAndre Weissflog <floooh@gmail.com>2019-10-08 16:31:32 +0200
committerAndre Weissflog <floooh@gmail.com>2019-10-08 16:31:32 +0200
commit4f5f33aed33c8a540e9c244a8537073b1aafdf4f (patch)
treed27ee6b1f79b675ab154f97a5be6f7afb8980f25 /README.md
parentf80fcf6be00b63b56f83b49e439b58ba6d827172 (diff)
some more README tweaking
Diffstat (limited to 'README.md')
-rw-r--r--README.md16
1 files changed, 12 insertions, 4 deletions
diff --git a/README.md b/README.md
index fe8151bb..8540ce51 100644
--- a/README.md
+++ b/README.md
@@ -2,15 +2,15 @@
[![Build Status](https://github.com/floooh/sokol/workflows/build_and_test/badge.svg)](https://github.com/floooh/sokol/actions)
-**Sokol (Сокол)**: Russian for Falcon, a smaller and more nimble
-bird of prey than the Eagle (Орёл, Oryol)
+Simple
+[STB-style](https://github.com/nothings/stb/blob/master/docs/stb_howto.txt)
+cross-platform libraries for C and C++, written in C.
[See what's new](#updates) (**08-Sep-2019**: clamp-to-border texture sampling in sokol_gfx.h)
[Live Samples](https://floooh.github.io/sokol-html5/index.html) via WASM.
-Minimalistic STB-style cross-platform single-file-libs written in C (or
-rather 'the subset of C which compiles both in C and C++'):
+Cross-platform libraries:
- **sokol\_gfx.h**: 3D-API wrapper (GL + Metal + D3D11)
- **sokol\_app.h**: app framework wrapper (entry + window + 3D-context + input)
@@ -19,6 +19,14 @@ rather 'the subset of C which compiles both in C and C++'):
- **sokol\_fetch.h**: asynchronous data streaming from HTTP and local filesystem
- **sokol\_args.h**: unified cmdline/URL arg parser for web and native apps
+Utility libraries:
+
+- **sokol\_imgui.h**: sokol_gfx.h rendering backend for [Dear ImGui](https://github.com/ocornut/imgui)
+
+- **sokol\_gl.h**: OpenGL 1.x style immediate-mode rendering API on top of sokol_gfx.h
+- **sokol\_fontstash.h**: sokol_gl.h rendering backend for [fontstash](https://github.com/memononen/fontstash)
+- **sokol\_gfx\_imgui.h**: debug-inspection UI for sokol_gfx.h (implemented with Dear ImGui)
+
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.