diff options
| author | Luca Falavigna <dktrkranz@debian.org> | 2010-01-02 20:56:35 +0100 |
|---|---|---|
| committer | Luca Falavigna <dktrkranz@debian.org> | 2010-01-02 20:56:35 +0100 |
| commit | 64c458487151933ee0ba093cf4ac69e177d9be37 (patch) | |
| tree | f6e3755704f53406eea85532e4ffe5d5ef50b7f0 /doc/user/README | |
| parent | 2aec9cc58398cac1376509a7d75edb83b41f984e (diff) | |
| parent | 72c578fd4b0b4a5a43e18594339ac4ff26c376dc (diff) | |
Merge commit 'upstream/1.2.0.d20091224'
Diffstat (limited to 'doc/user/README')
| -rw-r--r-- | doc/user/README | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/doc/user/README b/doc/user/README new file mode 100644 index 0000000..aef479a --- /dev/null +++ b/doc/user/README @@ -0,0 +1,21 @@ +# Copyright (c) 2001, 2002, 2003, 2004, 2005, 2006, 2007, 2008, 2009 The SCons Foundation + +When adding a new file, add it to main.xml and MANIFEST. + +To build the .xml files from the .in files: + scons -D BUILDDOC=1 foo.xml +To build the whole PDF doc from this dir, for testing: + scons -D ../../build/doc/PDF/scons-user.pdf + +Writing examples: here's a simple template. + + <scons_example name="Foo"> + <file name="SConstruct"> + env = Environment() + print env.Dump("CC") + </file> + </scons_example> + + <scons_output example="Foo"> + <scons_output_command>scons -Q</scons_output_command> + </scons_output> |