From: Daniel Kochmański <daniel@turtleware.eu>
Date: Sun, 23 Aug 2015 10:56:57 +0000 (+0200)
Subject: readme: fix top-level README (move to src/doc/debugging)
X-Git-Url: http://git.pulsar-zone.net/?a=commitdiff_plain;h=c051af5a9717df17a7fd6e254c5f0c891888131d;p=ecl.git

readme: fix top-level README (move to src/doc/debugging)

Signed-off-by: Daniel Kochmański <daniel@turtleware.eu>
---

diff --git a/README b/README
index 4219766..cfdcf30 100644
--- a/README
+++ b/README
@@ -1,49 +1,14 @@
-You can find the preprocessed documentation in ./doc in HTML format.
-
-Debugging via GDB:
-------------------
-
-src/util/gdbinit (and, therefore, build/.gdbinit) defines
-a few convenience things - T, NIL, and, even more important,
-ecl_print.
-
-This is a GDB function that prints a 'cl_object' human-readably:
-
-    (gdb) ecl_print x
-    $39 = t_fixnum
-    $40 = (ecl_base_char *) 0x42b4000 "10652336"
-
-And another that helps to see a thread state:
-
-    (gdb) ecl_eval "cl:*package*"
-
-Please note that double quotes have to be escaped:
-
-    (gdb) ecl_eval "(concatenate 'string \"a\" \"b\")"
-
-Both will give a string with "readable" content, and a pretty-printed one.
-
-
-
-Using VIM:
-----------
-
-.git/tags is a VIM-compatible tag file; if you're using
-the fugitive plugin, it will be used automatically.
-
-
-
-About testing:
---------------
-
-make check
-	to (get, initialize and) run the tests
-
-make -C build/tests do-regressions
-make -C build/tests do-ansi
-make -C build/tests do-quicklisp
-make -C build/tests do-mop-tests
-	runs the specified tests
-
-make -C build/tests/ show-fails
-	prints results
+ECL stands for Embeddable Common-Lisp. The ECL project aims to
+produce an implementation of the Common-Lisp language which complies
+to the ANSI X3J13 definition of the language.
+  
+The term embeddable refers to the fact that ECL includes a lisp to C
+compiler, which produces libraries (static or dynamic) that can be
+called from C programs. Furthermore, ECL can produce standalone
+executables from your lisp code and can itself be linked to your
+programs as a shared library.
+  
+ECL supports the operating systems Linux, FreeBSD, NetBSD, OpenBSD,
+Solaris (at least v. 9), Microsoft Windows and OSX, running on top of
+the Intel, Sparc, Alpha, ARM and PowerPC processors.  Porting to other
+architectures should be rather easy.
diff --git a/src/doc/debugging b/src/doc/debugging
new file mode 100644
index 0000000..4219766
--- /dev/null
+++ b/src/doc/debugging
@@ -0,0 +1,49 @@
+You can find the preprocessed documentation in ./doc in HTML format.
+
+Debugging via GDB:
+------------------
+
+src/util/gdbinit (and, therefore, build/.gdbinit) defines
+a few convenience things - T, NIL, and, even more important,
+ecl_print.
+
+This is a GDB function that prints a 'cl_object' human-readably:
+
+    (gdb) ecl_print x
+    $39 = t_fixnum
+    $40 = (ecl_base_char *) 0x42b4000 "10652336"
+
+And another that helps to see a thread state:
+
+    (gdb) ecl_eval "cl:*package*"
+
+Please note that double quotes have to be escaped:
+
+    (gdb) ecl_eval "(concatenate 'string \"a\" \"b\")"
+
+Both will give a string with "readable" content, and a pretty-printed one.
+
+
+
+Using VIM:
+----------
+
+.git/tags is a VIM-compatible tag file; if you're using
+the fugitive plugin, it will be used automatically.
+
+
+
+About testing:
+--------------
+
+make check
+	to (get, initialize and) run the tests
+
+make -C build/tests do-regressions
+make -C build/tests do-ansi
+make -C build/tests do-quicklisp
+make -C build/tests do-mop-tests
+	runs the specified tests
+
+make -C build/tests/ show-fails
+	prints results