summaryrefslogtreecommitdiff
path: root/doc/user/README
blob: b8ab21f2ff86ef35943575cdabc76df65aa6d73b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# Copyright (c) 2001 - 2014 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>