Browse files

Refactor the little documentation.

  • Loading branch information...
pupeno committed Nov 26, 2005
1 parent 6f0ce58 commit 2fdfe9b08c8a8eed482a0169c5265fe3b5de8e83
Showing with 20 additions and 7 deletions.
  1. +20 −7 README
@@ -3,15 +3,25 @@ Scons-chicken
Scons-chicken is an add-on for SCons (, a building system (much like make and autotools, all in one), that adds support for Chicken (, a Scheme-to-C compiler.
+To compile and install this extension you'll need:
+- SCons, because that is the build tool used. More on
+- Chicken, because thes extension includes a helper program. More on
-To install it you'll need SCons ( and all you need is to run:
- scons install
-and it will install on /usr/lib/scons/Scons/Tool/. If you installed SCons somewhere else, edit SConstruct and fix.
-If you know of a better fix that will work no matter where you installed SCons (that is, something that will automatically find out where to place, then, please, tell me about it (
+Find out the prefix of your SCons installation. Search for paths like /usr/lib/scons/SCons/Tool/, /usr/local/lib/scons/SCons/Tool/ or something similar. On those cases, the prefixes for SCons are /usr and /usr/local/ respectively.
+Decide the prefix used for chicken-il, a program that is needed by this extension and that is going to be installed.
+Once you collected those two pieces of information, run 'scons' passing them as the parameters SCONSPREFIX and PREFIX, like:
+ scons SCONSPREFIX=/usr PREFIX=/usr/local
+For more information:
+ scons --help
+Always on the root directory of scons-chicken.
+Scons-chicken tries to be as SConish as possible.
To learn how to use scons-chicken, check out the examples directories:
- sc-sap: scons-chicken stand-alone-program (doesn't depend on any library).
- sc-ofl: scons-chicken one-file-library.
@@ -20,6 +30,9 @@ To learn how to use scons-chicken, check out the examples directories:
- sc-mfp: scons-chicken multiple-file-program (depends on sc-tfl).
- sc-lap: scons-chicken library-and-file (it is a mix of ofl and ofp).
-It can't create extensions of multiple libraries (but it can create libraries of multiple files).
+This builders helps creating an Egg, the Chicken extensions.
+It doesn't create a .setup file, that is still your task (an automatig .setup generation may be added in the future). This builder tars the sources.
+The good thing abouth this builder is that you can pass the generated file of a compilation and get the right sources packaged (even those included and not compiled directly!).
+For more information, see the example.

0 comments on commit 2fdfe9b

Please sign in to comment.