cleanup src/linux and src/misc trees, etc.
[musl] / README
1
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.
6
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,
10
11     http://www.etalabs.net/musl/
12
13 For installation instructions, see the INSTALL file.
14
15 Please refer to the COPYRIGHT file for details on the copyright and
16 license status of code included in musl (standard MIT license).
17
18
19
20 Greetings!
21
22 With the 0.9.0 release, musl has reached a milestone in completeness
23 and compatibility. All interfaces in ISO C99 and POSIX 2008 base exist
24 in musl, along with a number of non-standardized interfaces based on
25 GNU and BSD libraries and syscall interfaces for Linux-kernel-specific
26 functions. Some interfaces lack obscure or rarely-used functionality
27 needed for strict conformance, but the vast majority of interfaces go
28 above and beyond the requirements for conformance, often promising
29 success where other implementations can fail under resource exhaustion
30 or other corner-case conditions.
31
32 At this point, hundreds of packages have been successfully built
33 against musl - either out-of-the-box or with minor patches to address
34 portability errors - ranging from low-level system utilities and
35 network daemons to major gui applications. Testing has been conducted
36 using three separate test frameworks and numerous additional
37 standalone test cases to verify the correctness of the implementation.
38
39 Included with this package is a gcc wrapper script (musl-gcc) which
40 allows you to build musl-linked programs using an existing gcc 3.x or
41 4.x toolchain on the host. There are also now at several mini
42 distributions (in the form of build scripts) which provide a
43 self-hosting musl-based toolchain and system root. These are much
44 better options than the wrapper script if you wish to use dynamic
45 linking or build packages with many library dependencies. See the musl
46 website for details.
47
48 The musl project is actively seeking contributors, mostly in the areas
49 of porting, testing, and application compatibility improvement. For
50 bug reports, support requests, or to get involved in development,
51 please visit #musl on Freenode IRC or subscribe to the musl mailing
52 list by sending a blank email to musl-subscribe AT lists DOT openwall
53 DOT com.
54
55 Thank you for using musl.
56
57 Cheers,
58
59 Rich Felker / dalias
60
61