fix header typo
[musl.git] / README
blob666176c7deeb25b18420b1ca95eab0c722c4becd
2 musl libc - a new standard library to power a new generation of
3 Linux-based devices. musl is lightweight, fast, simple, free, and
4 strives to be correct in the sense of standards-conformance and
5 safety.
7 musl is an alternative to glibc, eglibc, uClibc, dietlibc, and klibc.
8 For reasons why one might prefer musl, please see the FAQ and libc
9 comparison chart on the project website,
11     http://www.etalabs.net/musl/
13 For installation instructions, see the INSTALL file.
15 Please refer to the COPYRIGHT file for details on the copyright status
16 of code included in musl, and the COPYING file for the license (LGPL)
17 under which the library as a whole is distributed.
21 Greetings!
23 As of the 0.8.0 release, musl is in _beta_ status. While some
24 interfaces remain incomplete or yet to be implemented, the ABI is
25 intended to be stable at this point, and serious efforts have been
26 made, using three separate test frameworks, to verify the correctness
27 of the implementation. Many major system-level and user-level programs
28 are known to work with musl, either out-of-the-box or with minor
29 patches to address portability errors.
31 Included with this package is a gcc wrapper script (musl-gcc) which
32 allows you to build musl-linked programs using an existing gcc 4.x
33 toolchain on the host. There are also now at least two mini
34 distributions (in the form of build scripts) which provide a
35 self-hosting musl-based toolchain and system root: Sabotage Linux and
36 Bootstrap Linux. These are much better options than the wrapper script
37 if you wish to use dynamic linking or build packages with many library
38 dependencies.
40 The musl project is actively seeking contributors, mostly in the areas
41 of porting, testing, and application compatibility improvement. For
42 bug reports, support requests, or to get involved in development,
43 please visit #musl on Freenode IRC or subscribe to the musl mailing
44 list by sending a blank email to musl-subscribe AT lists DOT openwall
45 DOT com.
47 Thank you for using musl.
49 Cheers,
51 Rich Felker / dalias