Skip to content
Browse files

Add Installation chapter to the manual.

  • Loading branch information...
1 parent 0f40767 commit 4619c456b00e43254ae5794480ac1627e0c53337 @luismbo luismbo committed Jul 29, 2008
Showing with 55 additions and 1 deletion.
  1. +3 −0 README
  2. +52 −1 doc/cffi-manual.texinfo
View
3 README
@@ -15,3 +15,6 @@ particular, UFFI's use of aliens in CMUCL and SBCL can be tricky to
get right. CFFI avoids this by using system area pointers directly
instead of alien objects. All foreign function definitions and uses
should compile without alien-value compiler notes in CMUCL/SBCL.
+
+Please consult the manual for further details, including installation
+instructions.
View
53 doc/cffi-manual.texinfo
@@ -114,7 +114,7 @@
@copying
Copyright @copyright{} 2005 James Bielman <jamesjb at jamesjb.com> @*
-Copyright @copyright{} 2005-2007 Lu@'{@dotless{i}}s Oliveira
+Copyright @copyright{} 2005-2008 Lu@'{@dotless{i}}s Oliveira
<loliveira at common-lisp.net> @*
Copyright @copyright{} 2006 Stephen Compall <s11 at member.fsf.org>
@@ -161,6 +161,7 @@ software or the use or other dealings in the software.}
@menu
* Introduction:: What is CFFI?
+* Installation::
* Implementation Support::
* Tutorial:: Interactive intro to using CFFI.
* Wrapper generators:: CFFI forms from munging C source code.
@@ -322,6 +323,56 @@ for performance, use a compiler-macro instead.
@c ===================================================================
+@c CHAPTER: Installation
+
+@node Installation
+@chapter Installation
+
+@cffi{} can be obtained through one of the following means available
+through its @uref{http://common-lisp.net/project/cffi/,,website}:
+
+@itemize
+@item
+@uref{http://common-lisp.net/project/cffi/releases/?M=D,,official release
+tarballs}
+
+@item
+@uref{http://common-lisp.net/project/cffi/darcs/cffi,,darcs
+repository}
+
+@item
+@uref{http://common-lisp.net/project/cffi/tarballs/?M=D,,nightly-generated
+snapshots}
+
+@end itemize
+
+In addition, you will need to obtain and install the following
+dependencies:
+
+@itemize
+@item
+@uref{http://common-lisp.net/project/babel/,,Babel}, a charset
+encoding/decoding library.
+
+@item
+@uref{http://common-lisp.net/project/alexandria/,,Alexandria}, a
+collection of portable public-domain utilities.
+
+@item
+@uref{http://www.cliki.net/trivial-features,,trivial-features}, a
+portability layer that ensure consistent @code{*features*} across
+multiple Common Lisp implementations.
+
+@end itemize
+
+You may find mechanisms such as
+@uref{http://common-lisp.net/project/clbuild/,,clbuild} (recommended)
+or @uref{http://www.cliki.net/ASDF-Install,,ASDF-Install} (not as
+recommendable) helpful in getting and managing @cffi{} and its
+dependencies.
+
+
+@c ===================================================================
@c CHAPTER: Implementation Support
@node Implementation Support

0 comments on commit 4619c45

Please sign in to comment.
Something went wrong with that request. Please try again.