source: trunk/source/doc/src/ide.xml @ 8673

Last change on this file since 8673 was 8673, checked in by mikel, 12 years ago

added documentation of stack sizes, with-encoded-cstrs. added a section documenting the IDE.

File size: 2.8 KB
1<?xml version="1.0" encoding="utf-8"?>
2<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
3          ""[
4          <!ENTITY rest "<varname>&amp;rest</varname>">
5          <!ENTITY key "<varname>&amp;key</varname>">
6          <!ENTITY optional "<varname>&amp;optional</varname>">
7          <!ENTITY body "<varname>&amp;body</varname>">
8          <!ENTITY aux "<varname>&amp;aux</varname>">
9          <!ENTITY allow-other-keys "<varname>&amp;allow-other-keys</varname>">
10          <!ENTITY CCL "<literal>CCL</literal>">
11          ]>
13<chapter><title>The &CCL; IDE</title>
15  <sect1><title>Introduction</title>
17    <para>Clozure CL ships with the source code for a simple Cocoa
18      integrated development environment that runs on Mac OS X. This
19      chapter describes how to build and use that environment,
20      referred to hereafter simply as "the IDE".</para>
22    <para>The IDE is still in a preliminary state, and may lack many
23    features you would expect to find in a polished Cocoa
24    application. It does, however, provide a text editor and listener
25    windows, an inspector for Lisp data structures, and a means of
26    easily building a Cocoa application in Lisp. In addition, its
27    source code provides an example of a fairly complex Cocoa
28    application written in Lisp.</para>
30    <para>A more rudimentary version of the Clozure CL IDE has been
31      included for several years with the distribution. The current
32      version of the IDE has seen the addition of numerous features
33      and many bugfixes. Although it's by no means a finished product,
34      we hope it will prove more useful than previous versions, and we
35      plan additional work on the IDE for future releases.</para>
36  </sect1>
38  <sect1><title>Building the IDE</title>
40    <para>Building the Clozure CL IDE is now a very simple
41    process.</para>
43    <orderedlist>
44      <listitem>
45        <para>In a shell session, cd to the ccl directory.</para>
46      </listitem>
47      <listitem>
48        <para>Run ccl from the shell. The easiest way to do this is
49        generally to execute the openmcl or openmcl64 command.</para>
50      </listitem>
51      <listitem>
52        <para>Evaluate the form <code language="lisp">(require :cocoa-application)</code></para>
53      </listitem>
54    </orderedlist>
56    <para>Clozure CL compiles and loads the various subsystems that
57      make up the IDE, then constructs a Cocoa application bundle
58      named "Clozure" and saves the Lisp image into
59      it. Normally &CCL; creates the application bundle in the root
60      directory of the &CCL; distribution.</para>
62  </sect1>
64  <sect1><title>Running the IDE</title>
66    <para>After it has been built, you can run the "Clozure"
67      application normally, by double-clicking its icon.</para>
68  </sect1>
Note: See TracBrowser for help on using the repository browser.