Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Add Installation chapter to the manual.

  • Loading branch information...
commit 4619c456b00e43254ae5794480ac1627e0c53337 1 parent 0f40767
Luís Oliveira luismbo authored

Showing 2 changed files with 55 additions and 1 deletion. Show diff stats Hide diff stats

  1. +3 0  README
  2. +52 1 doc/cffi-manual.texinfo
3  README
@@ -15,3 +15,6 @@ particular, UFFI's use of aliens in CMUCL and SBCL can be tricky to
15 15 get right. CFFI avoids this by using system area pointers directly
16 16 instead of alien objects. All foreign function definitions and uses
17 17 should compile without alien-value compiler notes in CMUCL/SBCL.
  18 +
  19 +Please consult the manual for further details, including installation
  20 +instructions.
53 doc/cffi-manual.texinfo
@@ -114,7 +114,7 @@
114 114
115 115 @copying
116 116 Copyright @copyright{} 2005 James Bielman <jamesjb at jamesjb.com> @*
117   -Copyright @copyright{} 2005-2007 Lu@'{@dotless{i}}s Oliveira
  117 +Copyright @copyright{} 2005-2008 Lu@'{@dotless{i}}s Oliveira
118 118 <loliveira at common-lisp.net> @*
119 119 Copyright @copyright{} 2006 Stephen Compall <s11 at member.fsf.org>
120 120
@@ -161,6 +161,7 @@ software or the use or other dealings in the software.}
161 161
162 162 @menu
163 163 * Introduction:: What is CFFI?
  164 +* Installation::
164 165 * Implementation Support::
165 166 * Tutorial:: Interactive intro to using CFFI.
166 167 * Wrapper generators:: CFFI forms from munging C source code.
@@ -322,6 +323,56 @@ for performance, use a compiler-macro instead.
322 323
323 324
324 325 @c ===================================================================
  326 +@c CHAPTER: Installation
  327 +
  328 +@node Installation
  329 +@chapter Installation
  330 +
  331 +@cffi{} can be obtained through one of the following means available
  332 +through its @uref{http://common-lisp.net/project/cffi/,,website}:
  333 +
  334 +@itemize
  335 +@item
  336 +@uref{http://common-lisp.net/project/cffi/releases/?M=D,,official release
  337 +tarballs}
  338 +
  339 +@item
  340 +@uref{http://common-lisp.net/project/cffi/darcs/cffi,,darcs
  341 +repository}
  342 +
  343 +@item
  344 +@uref{http://common-lisp.net/project/cffi/tarballs/?M=D,,nightly-generated
  345 +snapshots}
  346 +
  347 +@end itemize
  348 +
  349 +In addition, you will need to obtain and install the following
  350 +dependencies:
  351 +
  352 +@itemize
  353 +@item
  354 +@uref{http://common-lisp.net/project/babel/,,Babel}, a charset
  355 +encoding/decoding library.
  356 +
  357 +@item
  358 +@uref{http://common-lisp.net/project/alexandria/,,Alexandria}, a
  359 +collection of portable public-domain utilities.
  360 +
  361 +@item
  362 +@uref{http://www.cliki.net/trivial-features,,trivial-features}, a
  363 +portability layer that ensure consistent @code{*features*} across
  364 +multiple Common Lisp implementations.
  365 +
  366 +@end itemize
  367 +
  368 +You may find mechanisms such as
  369 +@uref{http://common-lisp.net/project/clbuild/,,clbuild} (recommended)
  370 +or @uref{http://www.cliki.net/ASDF-Install,,ASDF-Install} (not as
  371 +recommendable) helpful in getting and managing @cffi{} and its
  372 +dependencies.
  373 +
  374 +
  375 +@c ===================================================================
325 376 @c CHAPTER: Implementation Support
326 377
327 378 @node Implementation Support

0 comments on commit 4619c45

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