Recent changes to Install-howto

Install-howto modified by David A. Wheeler

David A. Wheeler — Tue, 09 Dec 2014 20:00:05 -0000

--- v90
+++ v91
@@ -5,7 +5,7 @@
 For the impatient: Source installs
 ==================================

-If you're completely impatient, and you want to install the current released version from source on a Unix-like system (including Cygwin), just install the packages *guile*, *expect*, *clisp*, and *asdf* (asdf is often the package "cl-asdf").  You might also install *sbcl*.  Then download the current stable version from https://sourceforge.net/projects/readable/files/ and run the following command-line commands:
+If you're completely impatient, and you want to install the current released version from source on a Unix-like system (including Cygwin), just install the packages *guile*, *expect*, *sbcl* or *clisp*, and *asdf* (asdf is often the package "cl-asdf").  You might also install *sbcl*.  Then download the current stable version from https://sourceforge.net/projects/readable/files/ and run the following command-line commands:

     tar xvzf readable-*.tar.gz
     cd readable-*
@@ -23,7 +23,7 @@

 If you're completely impatient, and if you just want to *use* the "readable" library from Common Lisp code (regardless of underlying platform), QuickLisp is the easy solution.  This approach will not install tools (such as "sweeten" or "unsweeten"), but for a lot of Common Lisp users that may be okay.

-First, install *[QuickLisp](http://www.quicklisp.org/)*.  A QuickLisp install should simply involve starting your implementation of Common Lisp, downloading the [QuickLisp](http://www.quicklisp.org/) file, starting your implementation of Common Lisp (such as *clisp* or *sbcl*), then running:
+First, install *[QuickLisp](http://www.quicklisp.org/)*.  A QuickLisp install should simply involve starting your implementation of Common Lisp, downloading the [QuickLisp](http://www.quicklisp.org/) file, starting your implementation of Common Lisp (such as *sbcl* or *clisp*), then running:

     (load "quicklisp.lisp")
     (quicklisp-quickstart:install)  ; Install QuickLisp (also installs ASDF)
@@ -33,7 +33,7 @@

     (ql:quickload "readable")

-The first time you run *(ql:quickload "readable")* the QuickLisp system will download the current "master" version of the "readable" library as it's stored in the QuickLisp repository.  By default QuickLisp will put the library code inside "~/quicklisp".
+The first time you run *(ql:quickload "readable")* the QuickLisp system will download the current "master" version of the "readable" library as it's stored in the QuickLisp repository.  By default QuickLisp will put the library code inside "~/quicklisp".  The readable library should work on any Common Lisp implementation; sbcl is known to work well.  The clisp implementation of Common Lisp has some unfortunate quirks, but readable does work on clisp.

 You should be done!
 ===================
@@ -55,7 +55,7 @@

 If you're going to use Common Lisp, you also need:

-*   *clisp*, *sbcl*, or some other implementation of Common Lisp.  Cygwin includes a clisp package, so if you use Cygwin, that's the easiest option.  The "readable" software should work with any implementation of Common Lisp; please let us know if there's a problem.
+*   *sbcl*, *clisp*, or some other implementation of Common Lisp.  If you use Cygwin, clisp is probably the easiest option.  Clisp has some unfortunate quirks (as described in the tutorial), so you might consider using sbcl instead, but readable *does* work on clisp.  The "readable" software should work with any implementation of Common Lisp; please let us know if there's a problem.
 *   *[ASDF](http://common-lisp.net/project/asdf/)* (typically packaged with the name "cl-asdf").  You may need to configure ASDF, as discussed below.  As a convenience, we include a copy if you don't have your own copy.

 In most cases, users of Linux distributions can just use their package managers (such as yum, apt-get, or a GUI front-end for them) to easily install the relevant packages and any dependencies.

Install-howto modified by David A. Wheeler

David A. Wheeler — Tue, 28 Oct 2014 17:35:58 -0000

--- v89
+++ v90
@@ -43,8 +43,8 @@
 However, if these impatient approaches aren't enough, below is information on how to go through an installation from source, step-by-step.

-Prerequisites
-=============
+Other installs: The prerequisites
+=================================

 You need a Unix-like (POSIX) system such as a Linux distribution (such as Red Hat Enterprise Linux, CentOS, Fedora, Debian, Ubuntu, Gentoo, or Slackware), FreeBSD, NetBSD, OpenBSD, MacOS, etc.  On Windows, just install and use Cygwin; that works very well.  Any modern GNU/Linux system should do nicely.

Install-howto modified by David A. Wheeler

David A. Wheeler — Tue, 28 Oct 2014 17:34:25 -0000

--- v88
+++ v89
@@ -5,7 +5,7 @@
 For the impatient: Source installs
 ==================================

-If you're completely impatient, and you want to install the current released version from source on a Unix-like system (including Cygwin), just install the packages *guile*, *expect*, *clisp*, and *asdf* (asdf is often the package "cl-asdf").  You might also install *sbcl*.  Then download the current stable version from [http://readable.sourceforge.net](http://readable.sourceforge.net) and run the following command-line commands:
+If you're completely impatient, and you want to install the current released version from source on a Unix-like system (including Cygwin), just install the packages *guile*, *expect*, *clisp*, and *asdf* (asdf is often the package "cl-asdf").  You might also install *sbcl*.  Then download the current stable version from https://sourceforge.net/projects/readable/files/ and run the following command-line commands:

     tar xvzf readable-*.tar.gz
     cd readable-*

Install-howto modified by David A. Wheeler

David A. Wheeler — Tue, 28 Oct 2014 17:32:43 -0000

--- v87
+++ v88
@@ -38,8 +38,7 @@
 You should be done!
 ===================

-For most people, that's all you need to do.  You might now want to check out the
-[Scheme-tutorial] or [Common-lisp-tutorial].
+For most people, that's all you need to do.  You might now want to check out the [Scheme-tutorial] or [Common-lisp-tutorial].

 However, if these impatient approaches aren't enough, below is information on how to go through an installation from source, step-by-step.

Install-howto modified by David A. Wheeler

David A. Wheeler — Tue, 28 Oct 2014 17:32:02 -0000

--- v86
+++ v87
@@ -35,7 +35,13 @@

 The first time you run *(ql:quickload "readable")* the QuickLisp system will download the current "master" version of the "readable" library as it's stored in the QuickLisp repository.  By default QuickLisp will put the library code inside "~/quicklisp".

-If these impatient approaches aren't enough, let's go through an installation from source, step-by-step.
+You should be done!
+===================
+
+For most people, that's all you need to do.  You might now want to check out the
+[Scheme-tutorial] or [Common-lisp-tutorial].
+
+However, if these impatient approaches aren't enough, below is information on how to go through an installation from source, step-by-step.

 Prerequisites

Install-howto modified by David A. Wheeler

David A. Wheeler — Tue, 28 Oct 2014 17:29:52 -0000

--- v85
+++ v86
@@ -5,7 +5,7 @@
 For the impatient: Source installs
 ==================================

-If you're completely impatient, and you want to install the current released version from source, just install the packages *guile*, *expect*, *clisp*, and *asdf* (asdf is often the package "cl-asdf").  You might also install *sbcl*.  Then download the current stable version from [http://readable.sourceforge.net](http://readable.sourceforge.net) and run the following command-line commands on your Unix-like system (including Cygwin):
+If you're completely impatient, and you want to install the current released version from source on a Unix-like system (including Cygwin), just install the packages *guile*, *expect*, *clisp*, and *asdf* (asdf is often the package "cl-asdf").  You might also install *sbcl*.  Then download the current stable version from [http://readable.sourceforge.net](http://readable.sourceforge.net) and run the following command-line commands:

     tar xvzf readable-*.tar.gz
     cd readable-*
@@ -21,7 +21,7 @@
 For the impatient: QuickLisp Common Lisp library install
 ========================================================

-If you're completely impatient, and if you just want to *use* the "readable" library from Common Lisp code, QuickLisp is the easy solution.  This approach will not install tools (such as "sweeten" or "unsweeten"), but for a lot of Common Lisp users that may be okay.
+If you're completely impatient, and if you just want to *use* the "readable" library from Common Lisp code (regardless of underlying platform), QuickLisp is the easy solution.  This approach will not install tools (such as "sweeten" or "unsweeten"), but for a lot of Common Lisp users that may be okay.

 First, install *[QuickLisp](http://www.quicklisp.org/)*.  A QuickLisp install should simply involve starting your implementation of Common Lisp, downloading the [QuickLisp](http://www.quicklisp.org/) file, starting your implementation of Common Lisp (such as *clisp* or *sbcl*), then running:

Install-howto modified by David A. Wheeler

David A. Wheeler — Wed, 02 Jul 2014 04:46:23 -0000

--- v84
+++ v85
@@ -63,7 +63,7 @@
 If you plan to use the development (not stable) version directly from our git repository, you'll also need:

 *   *git* (to download the software).
-*   *autoconf*. You need autoconf version 2.67 or later.
+*   *autoconf*. You should use autoconf version 2.67 or later; use at least version 2.63.
 *   *automake*.  You should use version 1.14 or later; we haven't tested older versions.
 *   *guile development libraries* (e.g., package "guile-devel" on Fedora and Cygwin).  These need to match the version of guile you're using.
 *   *python* (to generate some HTML files from markdown).  You should have version 2.7+ or version 3+.  Version 2.4+ will do in a pinch (you need version 2.7 to auto-download markdown files, but only 2.4+ to generate HTML from them.)

Install-howto modified by David A. Wheeler

David A. Wheeler — Sun, 22 Jun 2014 19:10:07 -0000

--- v83
+++ v84
@@ -13,7 +13,7 @@
     make
     sudo make install

-Below are more details about each of those steps, including various options you can use.  You don't need to install to system-wide locations (so you *could* skip the last step), though it's slightly easier to use if you do.  If you want to install the *development* version instead of the released version, see below (you'll replace the first two commands with something else).
+Below are more details about each of those steps, including various options you can use.  You don't need to install to system-wide locations (so you *could* skip the last step), though it's slightly easier to use if you do.  If you want to install the *development* version instead of the released version, see below; you'll replace the first two commands to instead use *git* to obtain our *develop* branch.

 The "readable" software supports both Scheme (guile) and Common Lisp.  If you want, you can choose to install just the Scheme (guile) or just the Common Lisp portion.  In particular, if you don't already have an implementation of Common Lisp installed, you might try using the configuration option "--without-common-lisp"; setting up a usable Common Lisp system can take a few more steps as described below.

Install-howto modified by David A. Wheeler

David A. Wheeler — Sun, 22 Jun 2014 19:08:06 -0000

--- v82
+++ v83
@@ -127,7 +127,7 @@

      git clone git://git.code.sf.net/p/readable/code readable-code
      cd readable-code
-     git checkout develop  # Switch to "develop" branch
+     git checkout -b develop origin/develop  # Set up and switch to "develop" branch
      autoreconf -i

Install-howto modified by David A. Wheeler

David A. Wheeler — Sat, 14 Jun 2014 16:25:42 -0000

--- v81
+++ v82
@@ -1,4 +1,4 @@
-If your system or Lisp implementation has "readable" capabilities prepackaged, it's easiest to use that; see [Prepackaged] for a partial list.  But if that's not the case, here's how to install our "readable" software.  This software provides robust production-ready Scheme and Common Lisp implementations of our readable notations.
+If your system or Lisp implementation has "readable" capabilities prepackaged, it's easiest to use that; see [Prepackaged] for a partial list.  But if that's not the case, here's how to install our "readable" software.  This software provides robust production-ready Scheme and Common Lisp implementations of our readable notations, including their test suites, available as free/libre/open source software under the [MIT license](http://opensource.org/licenses/MIT).

 To install the "readable" software directly from our site, you need to have the right prerequisites, download and uncompress the software, configure it, build it, and then actually install it.  In most cases it should be easy, but we've provided some tips to help you avoid (or fix) problems.