updated readme
This commit is contained in:
parent
e418ae8c02
commit
0c4772d4b1
41
Readme.md
41
Readme.md
@ -82,47 +82,6 @@ nk_end(ctx);
|
||||
```
|
||||
![example](https://cloud.githubusercontent.com/assets/8057201/10187981/584ecd68-675c-11e5-897c-822ef534a876.png)
|
||||
|
||||
|
||||
##FAQ
|
||||
---
|
||||
#### Why single-file headers?
|
||||
Windows doesn't have standard directories where libraries
|
||||
live. That makes deploying libraries in Windows a lot more
|
||||
painful than open source developers on Unix-derivates generally
|
||||
realize. (It also makes library dependencies a lot worse in Windows.)
|
||||
|
||||
There's also a common problem in Windows where a library was built
|
||||
against a different version of the runtime library, which causes
|
||||
link conflicts and confusion. Shipping the libs as headers means
|
||||
you normally just compile them straight into your project without
|
||||
making libraries, thus sidestepping that problem.
|
||||
|
||||
Making them a single file makes it very easy to just
|
||||
drop them into a project that needs them. (Of course you can
|
||||
still put them in a proper shared library tree if you want.)
|
||||
|
||||
Why not two files, one a header and one an implementation?
|
||||
The difference between 10 files and 9 files is not a big deal,
|
||||
but the difference between 2 files and 1 file is a big deal.
|
||||
You don't need to zip or tar the files up, you don't have to
|
||||
remember to attach *two* files, etc.
|
||||
|
||||
#### Where is the documentation?
|
||||
Each file has documentation, basic ussage description and
|
||||
examples at the top of the file. In addition each API function,
|
||||
struct and member variables are documented as well.
|
||||
Finally each library has a corresponding test file inside the
|
||||
test directory for additional working examples.
|
||||
|
||||
#### Why C?
|
||||
Personally I primarily use C instead of C++ and since I want to
|
||||
support both C and C++ and C++ is not useable from C I therefore focus
|
||||
on C.
|
||||
|
||||
#### Why C89?
|
||||
I use C89 instead of C99/C11 for its portability between different compilers
|
||||
and accessiblity for other languages.
|
||||
|
||||
##CREDITS:
|
||||
Developed by Micha Mettke and every direct or indirect contributor to the GitHub.
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user