README-package.rst

   1 SCons - a software construction tool
   2 ####################################
   3
   4 .. image:: https://img.shields.io/badge/IRC-scons-blue.svg
   5    :target: http://webchat.freenode.net/?channels=%23scons&uio=d4
   6    :alt: IRC
   7
   8 .. image:: https://img.shields.io/sourceforge/dm/scons.svg
   9    :target: https://sourceforge.net/projects/scons
  10    :alt: Sourceforge Monthly Downloads
  11
  12 .. image:: https://img.shields.io/sourceforge/dt/scons.svg
  13    :target: https://sourceforge.net/projects/scons
  14    :alt: Sourceforge Total Downloads
  15
  16 .. image:: https://travis-ci.org/SCons/scons.svg?branch=master
  17    :target: https://travis-ci.org/SCons/scons
  18    :alt: Travis CI build status
  19
  20 .. image:: https://ci.appveyor.com/api/projects/status/github/SCons/scons?svg=true&branch=master
  21    :target: https://ci.appveyor.com/project/SCons/scons
  22    :alt: AppVeyor CI build Status
  23
  24 .. image:: https://codecov.io/gh/SCons/scons/branch/master/graph/badge.svg
  25    :target: https://codecov.io/gh/SCons/scons
  26    :alt: CodeCov Coverage Status
  27
  28 About SCons
  29 -----------
  30
  31 This is SCons, a tool for building software (and other files).  SCons is
  32 implemented in Python, and its "configuration files" are actually Python
  33 scripts, allowing you to use the full power of a real scripting language
  34 to solve build problems.  You do not, however, need to know Python to
  35 use SCons effectively.
  36
  37 Documentation
  38 -------------
  39
  40 Documentation for SCons is available at:
  41
  42         http://www.scons.org/documentation.html
  43
  44 Requirements
  45 ------------
  46
  47 Running SCons requires Python 3.5 or higher. There should be no other
  48 dependencies or requirements to run SCons.
  49
  50
  51 By default, SCons knows how to search for available programming tools on
  52 various systems--see the SCons man page for details.  You may, of course,
  53 override the default SCons choices made by appropriate configuration of
  54 Environment construction variables.
  55
  56
  57 Licensing
  58 =========
  59
  60 SCons is distributed under the MIT license, a full copy of which is available
  61 in the LICENSE file.
  62
  63
  64 Reporting Bugs
  65 ==============
  66
  67 The SCons project welcomes bug reports and feature requests.
  68
  69 Please make sure you send email with the problem or feature request to
  70 the SCons users mailing list:
  71
  72         Join via: http://two.pairlist.net/mailman/listinfo/scons-users
  73
  74 Or the SCons Discord server #scons-help channel
  75
  76         Server URL: https://discord.gg/bXVpWAy
  77
  78 Once you have discussed your issue on the users mailing list and the
  79 community has confirmed that it is either a new bug or a duplicate of an
  80 existing bug, then please follow the instructions the community provides
  81 to file a new bug or to add yourself to the CC list for an existing bug
  82
  83 You can explore the list of existing bugs, which may include workarounds
  84 for the problem you've run into on GitHub Issues:
  85
  86         https://github.com/SCons/scons/issues
  87
  88
  89 Mailing Lists
  90 =============
  91
  92 An active mailing list for developers of SCons is available.  You may
  93 send questions or comments to the list at:
  94
  95         scons-dev@scons.org
  96
  97 You may subscribe to the developer's mailing list using form on this page:
  98
  99         http://two.pairlist.net/mailman/listinfo/scons-dev
 100
 101 Subscription to the developer's mailing list is by approval.  In practice, no
 102 one is refused list membership, but we reserve the right to limit membership
 103 in the future and/or weed out lurkers.
 104
 105 There are other mailing lists available for SCons users, for notification of
 106 SCons code changes, and for notification of updated bug reports and project
 107 documents.  Please see our mailing lists page for details.
 108
 109
 110 Donations
 111 =========
 112
 113 If you find SCons helpful, please consider making a donation (of cash,
 114 software, or hardware) to support continued work on the project.  Information
 115 is available at:
 116
 117     http://www.scons.org/donate.html
 118
 119 or via GitHub Sponsors button on
 120
 121     https://github.com/scons/scons
 122
 123
 124 For More Information
 125 ====================
 126
 127 Check the SCons web site at:
 128
 129         http://www.scons.org/
 130
 131
 132 Copyright (c) 2001 - 2020 The SCons Foundation
 133