about summary refs log tree commit diff
path: root/README
diff options
context:
space:
mode:
authorRich Felker <dalias@aerifal.cx>2014-03-20 02:24:10 -0400
committerRich Felker <dalias@aerifal.cx>2014-03-20 02:24:10 -0400
commit4b0f39cb5333ada4761595d5faaf4248d849fabd (patch)
tree4e6521a115560698a8e4a24c9c4fe9a877e0e515 /README
parentcec05e0429cae43ef5d9e8b743994feacc6ca264 (diff)
downloadmusl-4b0f39cb5333ada4761595d5faaf4248d849fabd.tar.gz
musl-4b0f39cb5333ada4761595d5faaf4248d849fabd.tar.xz
musl-4b0f39cb5333ada4761595d5faaf4248d849fabd.zip
update README in preparation for release
reduces the amount of news-like content on progress and development
direction and focuses on the present.
Diffstat (limited to 'README')
-rw-r--r--README80
1 files changed, 21 insertions, 59 deletions
diff --git a/README b/README
index 65a7d3e7..5b7c70e5 100644
--- a/README
+++ b/README
@@ -1,62 +1,24 @@
 
-musl libc - a new standard library to power a new generation of
-Linux-based devices. musl is lightweight, fast, simple, free, and
-strives to be correct in the sense of standards-conformance and
-safety.
-
-musl is an alternative to glibc, eglibc, uClibc, dietlibc, and klibc.
-For reasons why one might prefer musl, please see the FAQ and libc
-comparison chart on the project website,
+    musl libc
+
+musl, pronounced like the word "mussel", is an MIT-licensed
+implementation of the standard C library targetting the Linux syscall
+API, suitable for use in a wide range of deployment environments. musl
+offers efficient static and dynamic linking support, lightweight code
+and low runtime overhead, strong fail-safe guarantees under correct
+usage, and correctness in the sense of standards conformance and
+safety. musl is built on the principle that these goals are best
+achieved through simple code that is easy to understand and maintain.
+
+The 1.0 release series for musl features coverage for all interfaces
+defined in ISO C99 and POSIX 2008 base, along with a number of
+non-standardized interfaces for compatibility with Linux, BSD, and
+glibc functionality. Also covered are all XSI interfaces except the
+dbm functions, which are traditionally a separate library from libc.
+
+For basic installation instructions, see the included INSTALL file.
+Information on full musl-targeted compiler toolchains, system
+bootstrapping, and Linux distributions built on musl can be found on
+the project website:
 
     http://www.musl-libc.org/
-
-For installation instructions, see the INSTALL file.
-
-Please refer to the COPYRIGHT file for details on the copyright and
-license status of code included in musl (standard MIT license).
-
-
-
-Greetings!
-
-The 0.9.x release series for musl features interface coverage for all
-interfaces defined in ISO C99 and POSIX 2008 base, along with a number
-of non-standardized interfaces for compatibility with Linux, BSD, and
-glibc functionality. As the release series progresses, we are
-gradually adding support for incomplete functionality in existing
-interfaces, additional functions that are deemed to be important due
-to their use in real-world software, and support for new library and
-language features in C11 such as thread-local storage, which is now
-supported on all targets. In addition, support for additional target
-cpu architectures is being added.
-
-The number of packages build successfully against musl - either
-out-of-the-box or with minor patches to address portability errors -
-has exceeded 5000 and is steadily growing. In addition to application
-compatibility testing, unit testing has been conducted using three
-separate test frameworks and numerous additional standalone test cases
-to verify the correctness of the implementation.
-
-Included with this package is a gcc wrapper script (musl-gcc) which
-allows you to build musl-linked programs using an existing gcc 3.x or
-4.x toolchain on the host. There are also now at several mini
-distributions (in the form of build scripts) which provide a
-self-hosting musl-based toolchain and system root. These are much
-better options than the wrapper script if you wish to use dynamic
-linking or build packages with many library dependencies. See the musl
-website for details.
-
-The musl project is actively seeking contributors, mostly in the areas
-of porting, testing, and application compatibility improvement. For
-bug reports, support requests, or to get involved in development,
-please visit #musl on Freenode IRC or subscribe to the musl mailing
-list by sending a blank email to musl-subscribe AT lists DOT openwall
-DOT com.
-
-Thank you for using musl.
-
-Cheers,
-
-Rich Felker / dalias
-
-