/usr/share/doc/cl-asdf/asdf/Quick-start-summary.html

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<!-- This manual describes ASDF, a system definition facility
for Common Lisp programs and libraries.

You can find the latest version of this manual at
https://common-lisp.net/project/asdf/asdf.html.

ASDF Copyright (C) 2001-2015 Daniel Barlow and contributors.

This manual Copyright (C) 2001-2015 Daniel Barlow and contributors.

This manual revised (C) 2009-2015 Robert P. Goldman and Francois-Rene Rideau.

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 -->
<!-- Created by GNU Texinfo 6.1, http://www.gnu.org/software/texinfo/ -->
<head>
<title>ASDF Manual: Quick start summary</title>

<meta name="description" content="ASDF Manual: Quick start summary">
<meta name="keywords" content="ASDF Manual: Quick start summary">
<meta name="resource-type" content="document">
<meta name="distribution" content="global">
<meta name="Generator" content="makeinfo">
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link href="index.html#Top" rel="start" title="Top">
<link href="Concept-Index.html#Concept-Index" rel="index" title="Concept Index">
<link href="index.html#SEC_Contents" rel="contents" title="Table of Contents">
<link href="index.html#Top" rel="up" title="Top">
<link href="Loading-ASDF.html#Loading-ASDF" rel="next" title="Loading ASDF">
<link href="Introduction.html#Introduction" rel="prev" title="Introduction">
<style type="text/css">
<!--
a.summary-letter {text-decoration: none}
blockquote.indentedblock {margin-right: 0em}
blockquote.smallindentedblock {margin-right: 0em; font-size: smaller}
blockquote.smallquotation {font-size: smaller}
div.display {margin-left: 3.2em}
div.example {margin-left: 3.2em}
div.lisp {margin-left: 3.2em}
div.smalldisplay {margin-left: 3.2em}
div.smallexample {margin-left: 3.2em}
div.smalllisp {margin-left: 3.2em}
kbd {font-style: oblique}
pre.display {font-family: inherit}
pre.format {font-family: inherit}
pre.menu-comment {font-family: serif}
pre.menu-preformatted {font-family: serif}
pre.smalldisplay {font-family: inherit; font-size: smaller}
pre.smallexample {font-size: smaller}
pre.smallformat {font-family: inherit; font-size: smaller}
pre.smalllisp {font-size: smaller}
span.nolinebreak {white-space: nowrap}
span.roman {font-family: initial; font-weight: normal}
span.sansserif {font-family: sans-serif; font-weight: normal}
ul.no-bullet {list-style: none}
-->
</style>


</head>

<body lang="en">
<a name="Quick-start-summary"></a>
<div class="header">
<p>
Next: <a href="Loading-ASDF.html#Loading-ASDF" accesskey="n" rel="next">Loading ASDF</a>, Previous: <a href="Introduction.html#Introduction" accesskey="p" rel="prev">Introduction</a>, Up: <a href="index.html#Top" accesskey="u" rel="up">Top</a> &nbsp; [<a href="index.html#SEC_Contents" title="Table of contents" rel="contents">Contents</a>][<a href="Concept-Index.html#Concept-Index" title="Index" rel="index">Index</a>]</p>
</div>
<hr>
<a name="Quick-start-summary-1"></a>
<h2 class="chapter">2 Quick start summary</h2>

<ul>
<li> To load an ASDF system:

<ul>
<li> Load ASDF itself into your Lisp image, using
<code>(require &quot;asdf&quot;)</code>.
Check that you have a recent version using <code>(asdf:asdf-version)</code>.
For more details, or if any of the above fails, see <a href="Loading-ASDF.html#Loading-ASDF">Loading ASDF</a>.

</li><li> Make sure software is installed where ASDF can find it.
The simplest way is to put all your Lisp code in subdirectories of
<samp>~/common-lisp/</samp> (starting with ASDF 3.1.2),
or <samp>~/.local/share/common-lisp/source/</samp>
(for ASDF 2 and later, or if you want to keep source in a hidden directory).
For more details, see <a href="Configuring-ASDF-to-find-your-systems.html#Configuring-ASDF-to-find-your-systems">Configuring ASDF to find your systems</a>.

</li><li> Load your system with <code>(asdf:load-system &quot;<var>my-system</var>&quot;)</code>.
See <a href="Using-ASDF.html#Using-ASDF">Using ASDF</a>.

</li></ul>

</li><li> To make your own ASDF system:

<ul>
<li> As above, load and configure ASDF.

</li><li> Make a new directory for your system, <code><var>my-system</var>/</code>,
again in a location where ASDF can find it.
All else being equal, the easiest location is probably
<samp>~/common-lisp/my-system/</samp>.
See <a href="Configuring-ASDF-to-find-your-systems.html#Configuring-ASDF-to-find-your-systems">Configuring ASDF to find your systems</a>.


</li><li> Create an ASDF system definition listing the dependencies of
your system, its components, and their interdependencies,
and put it in <samp><var>my-system</var>.asd</samp>.
This file must have the same name as your system, all lowercase.
See <a href="Defining-systems-with-defsystem.html#Defining-systems-with-defsystem">Defining systems with defsystem</a>.

</li><li> Use <code>(asdf:load-system &quot;<var>my-system</var>&quot;)</code>
to make sure it&rsquo;s all working properly. See <a href="Using-ASDF.html#Using-ASDF">Using ASDF</a>.

</li></ul>
</li></ul>









</body>
</html>
cl-asdf 2:3.1.6-1 / usr / share / doc / cl-asdf / asdf / Quick-start-summary.html
