From a2291e3e5dc81c41b4a79991e96663f8e8bd335d Mon Sep 17 00:00:00 2001 From: Sean Barrett Date: Mon, 14 Sep 2015 02:32:03 -0700 Subject: [PATCH] update single-file-libs list --- README.md | 107 +++++++++++++++++++++++++++++++++---------------- tools/README.footer.md | 105 ++++++++++++++++++++++++++++++++---------------- tools/README.header.md | 2 +- 3 files changed, 144 insertions(+), 70 deletions(-) diff --git a/README.md b/README.md index 0275fac..e8db515 100644 --- a/README.md +++ b/README.md @@ -3,7 +3,7 @@ stb === -single-file public domain libraries for C/C++ +single-file public domain libraries for C/C++ library | lastest version | category | LoC | description --------------------- | ---- | -------- | --- | -------------------------------- @@ -39,61 +39,94 @@ These libraries are in the public domain (or the equivalent where that is not possible). You can do anything you want with them. You have no legal obligation to do anything else, although I appreciate attribution. -#### Are there other single-file public-domain libraries out there? +#### Are there other single-file public-domain/open source libraries with minimal dependencies out there? Yes. I'll even tell you about some. However, I haven't used most of these libraries and can't comment on their quality. (If you use them and aren't their author, feel free to tell me about their quality.) -- [jo_gif.cpp](http://www.jonolick.com/home/gif-writer): tiny GIF writer (public domain) -- [gif.h](https://github.com/ginsweater/gif-h): animated GIF writer (public domain) -- [tiny_jpeg.h](https://github.com/serge-rgb/TinyJPEG/blob/master/tiny_jpeg.h): JPEG encoder (public domain) -- [lodepng](http://lodev.org/lodepng/): PNG encoder/decoder (zlib license) -- [nanoSVG](https://github.com/memononen/nanosvg): 1-file SVG parser; 1-file SVG rasterizer (zlib license) -- [tinyobjloader](https://github.com/syoyo/tinyobjloader): wavefront OBJ file loader (BSD license) -- [sdf.h](https://github.com/memononen/SDF): compute signed-distance field from antialiased image (MIT license) -- [nv_voronoi.h](http://www.icculus.org/~mordred/nvlib/): find voronoi regions on lattice w/ integer inputs (public domain) -- [nanoflann](https://github.com/jlblancoc/nanoflann): build KD trees for point clouds (BSD license) -- [SLRE](https://github.com/cesanta/slre): regular expression matcher (GPL v2) -- [DG_misc.h](https://github.com/DanielGibson/Snippets/): Daniel Gibson's stb.h-esque cross-platform helpers: path/file, strings (public domain) -- [MakeID.h](http://www.humus.name/3D/MakeID.h): allocate/deallocate small integer IDs efficiently (public domain) -- [utest](https://github.com/evolutional/utest): unit testing (MIT license) -- [catch](https://github.com/philsquared/Catch): unit testing (Boost license) -- [zed_net](https://github.com/ZedZull/zed_net): cross-platform socket wrapper (public domain) +- **images** [jo_gif.cpp](http://www.jonolick.com/home/gif-writer): tiny GIF writer (public domain) +- **images** [gif.h](https://github.com/ginsweater/gif-h): animated GIF writer (public domain) +- **images** [tiny_jpeg.h](https://github.com/serge-rgb/TinyJPEG/blob/master/tiny_jpeg.h): JPEG encoder (public domain) +- **images** [miniexr](https://github.com/aras-p/miniexr): OpenEXR writer (public domain) +- **geometry** [nv_voronoi.h](http://www.icculus.org/~mordred/nvlib/): find voronoi regions on lattice w/ integer inputs (public domain) +- **network** [zed_net](https://github.com/ZedZull/zed_net): cross-platform socket wrapper (public domain) +- **misc** [DG_misc.h](https://github.com/DanielGibson/Snippets/): Daniel Gibson's stb.h-esque cross-platform helpers: path/file, strings (public domain) +- **misc** [MakeID.h](http://www.humus.name/3D/MakeID.h): allocate/deallocate small integer IDs efficiently (public domain) + +Not public domain: + +- **images** [lodepng](http://lodev.org/lodepng/): PNG encoder/decoder (zlib license) +- **images** [nanoSVG](https://github.com/memononen/nanosvg): 1-file SVG parser; 1-file SVG rasterizer (zlib license) +- **3D** [tinyobjloader](https://github.com/syoyo/tinyobjloader): wavefront OBJ file loader (BSD license) +- **2D** [blendish](https://bitbucket.org/duangle/oui-blendish/src): blender-style widget rendering (MIT license) +- **geometry** [sdf.h](https://github.com/memononen/SDF): compute signed-distance field from antialiased image (MIT license) +- **geometry** [nanoflann](https://github.com/jlblancoc/nanoflann): build KD trees for point clouds (BSD license) +- **parsing** [SLRE](https://github.com/cesanta/slre): regular expression matcher (GPL v2) +- **tests** [utest](https://github.com/evolutional/utest): unit testing (MIT license) +- **tests** [catch](https://github.com/philsquared/Catch): unit testing (Boost license) +- **tests** [SPUT](http://www.lingua-systems.com/unit-testing/): unit testing (BSD license) There are some that have a source file and require a separate header file (which they may not even supply). That's twice as many files, and we at nothings/stb cannot condone this! But you might like them anyway: -- [pempek_assert.cpp](https://github.com/gpakosz/Assert/tree/master/src): C++ flexible assertions in C++ (WTFPL v2 license) -- [whereami](https://github.com/gpakosz/whereami): get path/filename of executable (WTFPL v2 license) -- [picopng.cpp](http://lodev.org/lodepng/picopng.cpp): tiny PNG loader (zlib license) -- [jpeg-compressor](https://github.com/richgel999/jpeg-compressor): 2-file jpeg compress, 2-file jpeg decompress (public domain) -- [lz4](https://github.com/Cyan4973/lz4): fast but larger LZ compression (BSD license) -- [fastlz](https://code.google.com/p/fastlz/source/browse/#svn%2Ftrunk): fast but larger LZ compression (MIT license) -- [tinyexr](https://github.com/syoyo/tinyexr): EXR image read/write, uses miniz internally (BSD license) -- [miniz.c](https://github.com/richgel999/miniz): zlib compression,decompression, zip file, png writing (public domain) -- [Remotery](https://github.com/Celtoys/Remotery): CPU/GPU profiler Win/Mac/Linux, using web browser for viewer (Apache 2.0 license) -- [MicroProfile](https://bitbucket.org/jonasmeyer/microprofile): CPU (and GPU?) profiler, 1-3 header files (unlicense) -- [Clipper](http://www.angusj.com/delphi/clipper.php): line & polygon clipping & offsetting (Boost license) -- [json.h](https://github.com/sheredom/json.h): JSON parser (public domain) -- [Zange](https://github.com/vurtun/zange/blob/master/json.c): another JSON parser (MIT license) -- [yocto](https://github.com/tom-seddon/yhs): non-production-use http server (public domain) -- [happyhttp](http://scumways.com/happyhttp/happyhttp.html): http client requests (zlib license) -- [tigr](https://bitbucket.org/rmitton/tigr/src): quick-n-dirty window text/graphics for Windows (public domain) +- **images** [picopng.cpp](http://lodev.org/lodepng/picopng.cpp): tiny PNG loader (zlib license) +- **images** [jpeg-compressor](https://github.com/richgel999/jpeg-compressor): 2-file jpeg compress, 2-file jpeg decompress (public domain) +- **images** [tinyexr](https://github.com/syoyo/tinyexr): EXR image read/write (BSD license) *uses miniz internally* +- **3D** [mikktspace](https://svn.blender.org/svnroot/bf-blender/trunk/blender/intern/mikktspace/): compute tangent space for normal mapping (zlib) +- **2D** [tigr](https://bitbucket.org/rmitton/tigr/src): quick-n-dirty window text/graphics for Windows (public domain) +- **2D** [noc_turtle](https://github.com/guillaumechereau/noc): procedural graphics generator (public domain) +- **geometry** [Tomas Akenine-Moller snippets](http://fileadmin.cs.lth.se/cs/Personal/Tomas_Akenine-Moller/code/): various 3D intersection calculations, not lib-ified (public domain) +- **geometry** [Clipper](http://www.angusj.com/delphi/clipper.php): line & polygon clipping & offsetting (Boost license) +- **network** [yocto](https://github.com/tom-seddon/yhs): non-production-use http server (public domain) +- **network** [happyhttp](http://scumways.com/happyhttp/happyhttp.html): http client requests (zlib license) +- **AI** [micropather](http://www.grinninglizard.com/MicroPather/): pathfinding with A* (zlib license) +- **compression** [miniz.c](https://github.com/richgel999/miniz): zlib compression,decompression, zip file, png writing (public domain) +- **compression** [lz4](https://github.com/Cyan4973/lz4): fast but larger LZ compression (BSD license) +- **compression** [fastlz](https://code.google.com/p/fastlz/source/browse/#svn%2Ftrunk): fast but larger LZ compression (MIT license) +- **compression** [pithy](https://github.com/johnezang/pithy): fast but larger LZ compression (BSD license) +- **profiling** [Remotery](https://github.com/Celtoys/Remotery): CPU/GPU profiler Win/Mac/Linux, using web browser for viewer (Apache 2.0 license) +- **profiling** [MicroProfile](https://bitbucket.org/jonasmeyer/microprofile): CPU (and GPU?) profiler, 1-3 header files (unlicense) *uses miniz internally* +- **parsing** [json.h](https://github.com/sheredom/json.h): JSON parser (public domain) +- **parsing** [Zange](https://github.com/vurtun/zange/blob/master/json.c): another JSON parser (MIT license) +- **misc** [utf8](https://github.com/sheredom/utf8.h): utf8 string library (zlib) +- **misc** [whereami](https://github.com/gpakosz/whereami): get path/filename of executable or module (WTFPL v2 license) +- **tests** [pempek_assert.cpp](https://github.com/gpakosz/Assert/tree/master/src): flexible assertions in C++ (WTFPL v2 license) There is also this XML library, but if you're using XML, shame on you: -- [tinyxml2](https://github.com/leethomason/tinyxml2): XML (zlib license) +- **parsing** [tinyxml2](https://github.com/leethomason/tinyxml2): XML (zlib license) + +*List FAQ* + +###### Can I link directly to this list? You can use [this URL](https://github.com/nothings/stb#other_libs) to link directly to this list. +###### Why isn't library XXX which is made of 3 or more files on this list? + +I draw the line arbitrarily at 2 files at most. (Note that some libraries that appear to +be two files require a separate LICENSE file, which made me leave them out). Some of these +libraries are still easy to drop into your project and build, so you might still be ok with them. +But since people come to stb for single-file public domain libraries, I feel that starts +to get too far from what we do here. + +###### Why isn't library XXX which is at most two files and has minimal other dependencies on this list? + +Probably because I don't know about it, feel free to submit an issue. But I might not include +it for various other reasons, including subtleties of what is 'minimal other dependencies' and +subtleties about what is 'lightweight'. + +###### Why isn't sqllite's amalgamated build on this list? + +Come on. #### If I wrap an stb library in a new library, does the new library have to be public domain? No. -#### A lot of these libraries seem redundant to existing open source libraries. Are they better somehow? +#### Some of these libraries seem redundant to existing open source libraries. Are they better somehow? Generally they're only better in that they're easier to integrate, easier to use, and easier to release (single file; good API; no @@ -101,6 +134,10 @@ attribution requirement). They may be less featureful, slower, and/or use more memory. If you're already using an equivalent library, there's probably no good reason to switch. +###### Can I link directly to the table of stb libraries? + +You can use [this URL](https://github.com/nothings/stb#stb_libs) to link directly to that list. + #### Why do you list "lines of code"? It's a terrible metric. Just to give you some idea of the internal complexity of the library, diff --git a/tools/README.footer.md b/tools/README.footer.md index c5ad21e..540d4da 100644 --- a/tools/README.footer.md +++ b/tools/README.footer.md @@ -8,61 +8,94 @@ These libraries are in the public domain (or the equivalent where that is not possible). You can do anything you want with them. You have no legal obligation to do anything else, although I appreciate attribution. -#### Are there other single-file public-domain libraries out there? +#### Are there other single-file public-domain/open source libraries with minimal dependencies out there? Yes. I'll even tell you about some. However, I haven't used most of these libraries and can't comment on their quality. (If you use them and aren't their author, feel free to tell me about their quality.) -- [jo_gif.cpp](http://www.jonolick.com/home/gif-writer): tiny GIF writer (public domain) -- [gif.h](https://github.com/ginsweater/gif-h): animated GIF writer (public domain) -- [tiny_jpeg.h](https://github.com/serge-rgb/TinyJPEG/blob/master/tiny_jpeg.h): JPEG encoder (public domain) -- [lodepng](http://lodev.org/lodepng/): PNG encoder/decoder (zlib license) -- [nanoSVG](https://github.com/memononen/nanosvg): 1-file SVG parser; 1-file SVG rasterizer (zlib license) -- [tinyobjloader](https://github.com/syoyo/tinyobjloader): wavefront OBJ file loader (BSD license) -- [sdf.h](https://github.com/memononen/SDF): compute signed-distance field from antialiased image (MIT license) -- [nv_voronoi.h](http://www.icculus.org/~mordred/nvlib/): find voronoi regions on lattice w/ integer inputs (public domain) -- [nanoflann](https://github.com/jlblancoc/nanoflann): build KD trees for point clouds (BSD license) -- [SLRE](https://github.com/cesanta/slre): regular expression matcher (GPL v2) -- [DG_misc.h](https://github.com/DanielGibson/Snippets/): Daniel Gibson's stb.h-esque cross-platform helpers: path/file, strings (public domain) -- [MakeID.h](http://www.humus.name/3D/MakeID.h): allocate/deallocate small integer IDs efficiently (public domain) -- [utest](https://github.com/evolutional/utest): unit testing (MIT license) -- [catch](https://github.com/philsquared/Catch): unit testing (Boost license) -- [zed_net](https://github.com/ZedZull/zed_net): cross-platform socket wrapper (public domain) +- **images** [jo_gif.cpp](http://www.jonolick.com/home/gif-writer): tiny GIF writer (public domain) +- **images** [gif.h](https://github.com/ginsweater/gif-h): animated GIF writer (public domain) +- **images** [tiny_jpeg.h](https://github.com/serge-rgb/TinyJPEG/blob/master/tiny_jpeg.h): JPEG encoder (public domain) +- **images** [miniexr](https://github.com/aras-p/miniexr): OpenEXR writer (public domain) +- **geometry** [nv_voronoi.h](http://www.icculus.org/~mordred/nvlib/): find voronoi regions on lattice w/ integer inputs (public domain) +- **network** [zed_net](https://github.com/ZedZull/zed_net): cross-platform socket wrapper (public domain) +- **misc** [DG_misc.h](https://github.com/DanielGibson/Snippets/): Daniel Gibson's stb.h-esque cross-platform helpers: path/file, strings (public domain) +- **misc** [MakeID.h](http://www.humus.name/3D/MakeID.h): allocate/deallocate small integer IDs efficiently (public domain) + +Not public domain: + +- **images** [lodepng](http://lodev.org/lodepng/): PNG encoder/decoder (zlib license) +- **images** [nanoSVG](https://github.com/memononen/nanosvg): 1-file SVG parser; 1-file SVG rasterizer (zlib license) +- **3D** [tinyobjloader](https://github.com/syoyo/tinyobjloader): wavefront OBJ file loader (BSD license) +- **2D** [blendish](https://bitbucket.org/duangle/oui-blendish/src): blender-style widget rendering (MIT license) +- **geometry** [sdf.h](https://github.com/memononen/SDF): compute signed-distance field from antialiased image (MIT license) +- **geometry** [nanoflann](https://github.com/jlblancoc/nanoflann): build KD trees for point clouds (BSD license) +- **parsing** [SLRE](https://github.com/cesanta/slre): regular expression matcher (GPL v2) +- **tests** [utest](https://github.com/evolutional/utest): unit testing (MIT license) +- **tests** [catch](https://github.com/philsquared/Catch): unit testing (Boost license) +- **tests** [SPUT](http://www.lingua-systems.com/unit-testing/): unit testing (BSD license) There are some that have a source file and require a separate header file (which they may not even supply). That's twice as many files, and we at nothings/stb cannot condone this! But you might like them anyway: -- [pempek_assert.cpp](https://github.com/gpakosz/Assert/tree/master/src): C++ flexible assertions in C++ (WTFPL v2 license) -- [whereami](https://github.com/gpakosz/whereami): get path/filename of executable (WTFPL v2 license) -- [picopng.cpp](http://lodev.org/lodepng/picopng.cpp): tiny PNG loader (zlib license) -- [jpeg-compressor](https://github.com/richgel999/jpeg-compressor): 2-file jpeg compress, 2-file jpeg decompress (public domain) -- [lz4](https://github.com/Cyan4973/lz4): fast but larger LZ compression (BSD license) -- [fastlz](https://code.google.com/p/fastlz/source/browse/#svn%2Ftrunk): fast but larger LZ compression (MIT license) -- [tinyexr](https://github.com/syoyo/tinyexr): EXR image read/write, uses miniz internally (BSD license) -- [miniz.c](https://github.com/richgel999/miniz): zlib compression,decompression, zip file, png writing (public domain) -- [Remotery](https://github.com/Celtoys/Remotery): CPU/GPU profiler Win/Mac/Linux, using web browser for viewer (Apache 2.0 license) -- [MicroProfile](https://bitbucket.org/jonasmeyer/microprofile): CPU (and GPU?) profiler, 1-3 header files (unlicense) -- [Clipper](http://www.angusj.com/delphi/clipper.php): line & polygon clipping & offsetting (Boost license) -- [json.h](https://github.com/sheredom/json.h): JSON parser (public domain) -- [Zange](https://github.com/vurtun/zange/blob/master/json.c): another JSON parser (MIT license) -- [yocto](https://github.com/tom-seddon/yhs): non-production-use http server (public domain) -- [happyhttp](http://scumways.com/happyhttp/happyhttp.html): http client requests (zlib license) -- [tigr](https://bitbucket.org/rmitton/tigr/src): quick-n-dirty window text/graphics for Windows (public domain) +- **images** [picopng.cpp](http://lodev.org/lodepng/picopng.cpp): tiny PNG loader (zlib license) +- **images** [jpeg-compressor](https://github.com/richgel999/jpeg-compressor): 2-file jpeg compress, 2-file jpeg decompress (public domain) +- **images** [tinyexr](https://github.com/syoyo/tinyexr): EXR image read/write (BSD license) *uses miniz internally* +- **3D** [mikktspace](https://svn.blender.org/svnroot/bf-blender/trunk/blender/intern/mikktspace/): compute tangent space for normal mapping (zlib) +- **2D** [tigr](https://bitbucket.org/rmitton/tigr/src): quick-n-dirty window text/graphics for Windows (public domain) +- **2D** [noc_turtle](https://github.com/guillaumechereau/noc): procedural graphics generator (public domain) +- **geometry** [Tomas Akenine-Moller snippets](http://fileadmin.cs.lth.se/cs/Personal/Tomas_Akenine-Moller/code/): various 3D intersection calculations, not lib-ified (public domain) +- **geometry** [Clipper](http://www.angusj.com/delphi/clipper.php): line & polygon clipping & offsetting (Boost license) +- **network** [yocto](https://github.com/tom-seddon/yhs): non-production-use http server (public domain) +- **network** [happyhttp](http://scumways.com/happyhttp/happyhttp.html): http client requests (zlib license) +- **AI** [micropather](http://www.grinninglizard.com/MicroPather/): pathfinding with A* (zlib license) +- **compression** [miniz.c](https://github.com/richgel999/miniz): zlib compression,decompression, zip file, png writing (public domain) +- **compression** [lz4](https://github.com/Cyan4973/lz4): fast but larger LZ compression (BSD license) +- **compression** [fastlz](https://code.google.com/p/fastlz/source/browse/#svn%2Ftrunk): fast but larger LZ compression (MIT license) +- **compression** [pithy](https://github.com/johnezang/pithy): fast but larger LZ compression (BSD license) +- **profiling** [Remotery](https://github.com/Celtoys/Remotery): CPU/GPU profiler Win/Mac/Linux, using web browser for viewer (Apache 2.0 license) +- **profiling** [MicroProfile](https://bitbucket.org/jonasmeyer/microprofile): CPU (and GPU?) profiler, 1-3 header files (unlicense) *uses miniz internally* +- **parsing** [json.h](https://github.com/sheredom/json.h): JSON parser (public domain) +- **parsing** [Zange](https://github.com/vurtun/zange/blob/master/json.c): another JSON parser (MIT license) +- **misc** [utf8](https://github.com/sheredom/utf8.h): utf8 string library (zlib) +- **misc** [whereami](https://github.com/gpakosz/whereami): get path/filename of executable or module (WTFPL v2 license) +- **tests** [pempek_assert.cpp](https://github.com/gpakosz/Assert/tree/master/src): flexible assertions in C++ (WTFPL v2 license) There is also this XML library, but if you're using XML, shame on you: -- [tinyxml2](https://github.com/leethomason/tinyxml2): XML (zlib license) +- **parsing** [tinyxml2](https://github.com/leethomason/tinyxml2): XML (zlib license) + +*List FAQ* + +###### Can I link directly to this list? You can use [this URL](https://github.com/nothings/stb#other_libs) to link directly to this list. +###### Why isn't library XXX which is made of 3 or more files on this list? + +I draw the line arbitrarily at 2 files at most. (Note that some libraries that appear to +be two files require a separate LICENSE file, which made me leave them out). Some of these +libraries are still easy to drop into your project and build, so you might still be ok with them. +But since people come to stb for single-file public domain libraries, I feel that starts +to get too far from what we do here. + +###### Why isn't library XXX which is at most two files and has minimal other dependencies on this list? + +Probably because I don't know about it, feel free to submit an issue. But I might not include +it for various other reasons, including subtleties of what is 'minimal other dependencies' and +subtleties about what is 'lightweight'. + +###### Why isn't sqllite's amalgamated build on this list? + +Come on. #### If I wrap an stb library in a new library, does the new library have to be public domain? No. -#### A lot of these libraries seem redundant to existing open source libraries. Are they better somehow? +#### Some of these libraries seem redundant to existing open source libraries. Are they better somehow? Generally they're only better in that they're easier to integrate, easier to use, and easier to release (single file; good API; no @@ -70,6 +103,10 @@ attribution requirement). They may be less featureful, slower, and/or use more memory. If you're already using an equivalent library, there's probably no good reason to switch. +###### Can I link directly to the table of stb libraries? + +You can use [this URL](https://github.com/nothings/stb#stb_libs) to link directly to that list. + #### Why do you list "lines of code"? It's a terrible metric. Just to give you some idea of the internal complexity of the library, diff --git a/tools/README.header.md b/tools/README.header.md index f30e631..71e765b 100644 --- a/tools/README.header.md +++ b/tools/README.header.md @@ -1,7 +1,7 @@ stb === -single-file public domain libraries for C/C++ +single-file public domain libraries for C/C++ library | lastest version | category | LoC | description --------------------- | ---- | -------- | --- | --------------------------------