ripping out developer-facing docuemntation and putting it into internals.scrbl

This commit is contained in:
Danny Yoo 2011-10-05 14:19:41 -04:00
parent bb34fcbae1
commit bad98ca95d
3 changed files with 58 additions and 54 deletions

View File

@ -44,8 +44,8 @@ cs019-doc:
setup: setup:
raco setup --no-docs -P dyoo whalesong.plt 1 4 raco setup --no-docs -P dyoo whalesong.plt 1 5
planet-link: planet-link:
raco planet link dyoo whalesong.plt 1 4 . raco planet link dyoo whalesong.plt 1 5 .

View File

@ -56,6 +56,61 @@
@author+email["Danny Yoo" "dyoo@hashcollision.org"] @author+email["Danny Yoo" "dyoo@hashcollision.org"]
@section{Installing Whalesong from github}
Although Whalesong has been deployed to
@link["http://planet.racket-lang.org"]{PLaneT}, you can download the
sources from the github repository and run from there instead. Doing
so requires doing a little bit of manual work. The steps are:
@itemlist[
@item{Check Whalesong out of Github.}
@item{Set up the PLaneT development link to your local Whalesong instance.}
@item{Run @link["http://docs.racket-lang.org/raco/setup.html"]{@tt{raco setup}} over Whalesong to finish the installation}]
We can check it out of the source repository in
@link["https://github.com/"]{GitHub}; the repository can be checked out by
using @tt{git clone}. At the command-line, clone the tree
with: @verbatim|{ $ git clone git://github.com/dyoo/whalesong.git }|
This should check the repository in the current directory.
Next, let's set up a @link["http://docs.racket-lang.org/planet/Developing_Packages_for_PLaneT.html#(part._devlinks)"]{PLaneT development link}. Make sure you are in the
parent directory that contains the @filepath{whalesong} repository, and
then run this on your command line:
@verbatim|{
$ planet link dyoo whalesong.plt 1 5 whalesong
}|
(You may need to adjust the @tt{1} and @tt{5} major/minor numbers a bit to be larger
than the latest version that's on PLaneT at the time.)
Let's make the @filepath{whalesong} launcher somewhere appropriate. Run Racket with the following
@racket[require]:
@racketblock[
(require (planet dyoo/whalesong/make-launcher))
]
This will create a @filepath{whalesong} executable in the current working directory.
Finally, we need to set up Whalesong with @tt{raco setup}.
Here's how to do this at the command
line:
@verbatim|{
$ raco setup -P dyoo whalesong.plt 1 5
}|
This should compile Whalesong. Any time the source code in
@filepath{whalesong} changes, we should repeat this @tt{raco setup}
step again.
@;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; @;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
@section{Internals} @section{Internals}
@;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;; @;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

View File

@ -191,68 +191,17 @@ Pacman.}
@subsection{Installing Whalesong} @subsection{Installing Whalesong}
At the time of this writing, although Whalesong has been deployed to
@link["http://planet.racket-lang.org"]{PLaneT}, the version on PLaneT
is probably a little out of date.
If you want to use Whalesong off of PLaneT, run the following to create If you want to use Whalesong off of PLaneT, run the following to create
the @filepath{whalesong} launcher: the @filepath{whalesong} launcher:
@codeblock|{ @codeblock|{
#lang racket/base #lang racket/base
(require (planet dyoo/whalesong:1:3/make-launcher)) (require (planet dyoo/whalesong:1:4/make-launcher))
}| }|
This will create a @filepath{whalesong} launcher in the current directory. This will create a @filepath{whalesong} launcher in the current directory.
@subsection{Installing Whalesong from github}
Otherwise, you can download the sources from the github repository.
Doing so requires doing a little bit of manual work. The steps are:
@itemlist[
@item{Check Whalesong out of Github.}
@item{Set up the PLaneT development link to your local Whalesong instance.}
@item{Run @link["http://docs.racket-lang.org/raco/setup.html"]{@tt{raco setup}} over Whalesong to finish the installation}]
We can check it out of the source repository in
@link["https://github.com/"]{GitHub}; the repository can be checked out by
using @tt{git clone}. At the command-line, clone the tree
with: @verbatim|{ $ git clone git://github.com/dyoo/whalesong.git }|
This should check the repository in the current directory.
Next, let's set up a @link["http://docs.racket-lang.org/planet/Developing_Packages_for_PLaneT.html#(part._devlinks)"]{PLaneT development link}. Make sure you are in the
parent directory that contains the @filepath{whalesong} repository, and
then run this on your command line:
@verbatim|{
$ planet link dyoo whalesong.plt 1 4 whalesong
}|
(You may need to adjust the @tt{1} and @tt{4} major/minor numbers a bit to be larger
than the latest version that's on PLaneT at the time.)
Let's make the @filepath{whalesong} launcher somewhere appropriate. Run Racket with the following
@racket[require]:
@racketblock[
(require (planet dyoo/whalesong/make-launcher))
]
This will create a @filepath{whalesong} executable in the current working directory.
Finally, we need to set up Whalesong with @tt{raco setup}.
Here's how to do this at the command
line:
@verbatim|{
$ raco setup -P dyoo whalesong.plt 1 4
}|
This should compile Whalesong. Any time the source code in
@filepath{whalesong} changes, we should repeat this @tt{raco setup}
step again.
At this point, you should be able to run the @filepath{whalesong} executable from the command line. At this point, you should be able to run the @filepath{whalesong} executable from the command line.
@verbatim|{ @verbatim|{
$ ./whalesong $ ./whalesong