OSDN Git Service

h8300: O_DIRECT and O_DIRECTIRY swapping.
[uclinux-h8/uclibc-ng.git] / README
diff --git a/README b/README
index fd882fc..002b6f9 100644 (file)
--- a/README
+++ b/README
@@ -1,64 +1,48 @@
-
-* Configuration:
-
-  ln -s ./extra/Configs/Config.<arch> ./Config
-
-Then edit ./Config for your setup.  In particular, modify CROSS and
-KERNEL_SOURCE as necessary.  You may also want to modify
-SHARED_LIB_LOADER_PATH, DEVEL_PREFIX, and SYSTEM_DEVEL_PREFIX depending
-on where you want to install the development environment.  By default,
-the development environment is installed into /usr/<arch>-linux-uclibc/.
-
-
-* Building:
-
-  make
-
-
-* Installing the development environment:
-
-(As root, if necessary,)
-
-  make install
-
-This will install the header files, libraries, and the gcc
-wrapper into the directories defined in Config.
-
-
-* Installing the target runtime environment:
-
-(As root, if necessary,)
-
-   make PREFIX=<temporary path> install_target
-
-This installs only the files that are necessary to run binaries
-compiled against uClibc.  Hint: You probably do not want to install
-the target runtime environment on your host machine.
-
-
-* Using uClibc:
-
-To compile programs with uClibc,
-
-   export PATH={uClibc DEVEL_PREFIX}/bin:$PATH
-
-and then just ./configure and make as usual.
-
-Note: 
-
-       You may also want to look at extra/gcc-uclibc/gcc-uclibc.c for
-       additional information concerning what options and environment
-       variables the gcc wrapper handles.
-
-Note2: 
-
-       There is an unwholesomely huge amount of code out there that
-       depends on the presence of GNU libc header files.  We have GNU
-       libc header files.  So we have committed a horrible sin in
-       uClibc.  We _lie_ and claim to be GNU libc in order to force
-       many applications to work as their developers intended.  This
-       is IMHO, pardonable, since these defines are not really
-       intended to check for the presence of a particular library, but
-       rather are used to define an _interface_.  Some programs (such
-       as GNU binutils) are especially chummy with glibc, and need
-       this behavior disabled by adding CFLAGS+=-D__FORCE_NOGLIBC
+  uClibc-ng - a small C Library for Linux
+
+uClibc-ng (aka µClibc-ng/pronounced yew-see-lib-see-next-generation) is a C
+library for developing embedded Linux systems. It is much smaller than the GNU
+C Library, but nearly all applications supported by glibc also work perfectly
+with uClibc-ng.
+
+uClibc-ng is a spin-off of uClibc from http://www.uclibc.org
+from Erik Andersen and others.
+
+Porting applications from glibc to uClibc-ng typically involves just
+recompiling the source code.  uClibc-ng even supports shared libraries and
+threading. It currently runs on standard Linux and MMU-less (also
+known as µClinux) systems with support for ARC, ARM, Blackfin, i386, M68K/Coldfire
+MIPS, MIPS64, PowerPC, SH, Sparc, X86_64 and XTENSA processors.
+
+If you are building an embedded Linux system and you find that
+glibc is eating up too much space, you should consider using
+uClibc-ng.  If you are building a huge fileserver with 12 Terabytes
+of storage, then using glibc may make more sense.  Unless, for
+example, that 12 Terabytes will be Network Attached Storage and
+you plan to burn Linux into the system's firmware...
+
+uClibc-ng is maintained by Waldemar Brodkorb and is licensed under the
+GNU LESSER GENERAL PUBLIC LICENSE.  This license allows you to
+make closed source commercial applications using an unmodified
+version of uClibc-ng. You do not need to give away all your source code just
+because you use uClibc-ng and/or run on Linux.  You should, however,
+carefuly review the license and make certain you understand and
+abide by it strictly.
+
+For installation instructions, see the file INSTALL.
+
+uClibc-ng strives to be standards compliant, which means that most
+documentation written for SuSv3, or for glibc also applies to
+uClibc-ng functions.  However, many GNU extensions are not supported
+because they have not been ported, or more importantly, would
+increase the size of uClibc-ng disproportional to the added
+functionality.
+
+Additional information can be found at http://www.uclibc-ng.org/.
+
+uClibc-ng may be freely modified and distributed under the terms of
+the GNU Lesser General Public License, which can be found in the
+file COPYING.
+
+And most of all, be sure to have some fun! :-)
+ -Waldemar