doc/user/README

   1 # SPDX-FileCopyrightText: Copyright The SCons Foundation (https://scons.org)
   2 # SPDX-License-Identifier: MIT
   3
   4 When adding a new file, add it to main.xml and MANIFEST.
   5
   6 To build the .xml files from the .in files:
   7   scons -D BUILDDOC=1 foo.xml
   8 To build the whole PDF doc from this dir, for testing:
   9   scons -D ../../build/doc/PDF/scons-user.pdf
  10
  11 Writing examples: here's a simple template.
  12
  13  <scons_example name="Foo">
  14    <file name="SConstruct">
  15     env = Environment()
  16     print(env.Dump("CC"))
  17    </file>
  18  </scons_example>
  19
  20  <scons_output example="Foo">
  21     <scons_output_command>scons -Q</scons_output_command>
  22  </scons_output>