diff options
author | William Deegan <bill@baddogconsulting.com> | 2020-07-04 20:15:21 (GMT) |
---|---|---|
committer | William Deegan <bill@baddogconsulting.com> | 2020-07-04 20:15:21 (GMT) |
commit | 90d2f836cd3ccdee0af03ebdd17f21d11183f91d (patch) | |
tree | 145fb285f909f346546ce3a5d02a7276d2ecabd0 /README-package.rst | |
parent | ecb9741551fa0276fccd7d8d6f1df03a4e338082 (diff) | |
download | SCons-90d2f836cd3ccdee0af03ebdd17f21d11183f91d.zip SCons-90d2f836cd3ccdee0af03ebdd17f21d11183f91d.tar.gz SCons-90d2f836cd3ccdee0af03ebdd17f21d11183f91d.tar.bz2 |
Add sepearat pypi README-package.rst for pypi's long description text
Diffstat (limited to 'README-package.rst')
-rwxr-xr-x | README-package.rst | 134 |
1 files changed, 134 insertions, 0 deletions
diff --git a/README-package.rst b/README-package.rst new file mode 100755 index 0000000..605e5fe --- /dev/null +++ b/README-package.rst @@ -0,0 +1,134 @@ +SCons - a software construction tool +#################################### + +.. image:: https://img.shields.io/badge/IRC-scons-blue.svg + :target: http://webchat.freenode.net/?channels=%23scons&uio=d4 + :alt: IRC + +.. image:: https://img.shields.io/sourceforge/dm/scons.svg + :target: https://sourceforge.net/projects/scons + :alt: Sourceforge Monthly Downloads + +.. image:: https://img.shields.io/sourceforge/dt/scons.svg + :target: https://sourceforge.net/projects/scons + :alt: Sourceforge Total Downloads + +.. image:: https://travis-ci.org/SCons/scons.svg?branch=master + :target: https://travis-ci.org/SCons/scons + :alt: Travis CI build status + +.. image:: https://ci.appveyor.com/api/projects/status/github/SCons/scons?svg=true&branch=master + :target: https://ci.appveyor.com/project/SCons/scons + :alt: AppVeyor CI build Status + +.. image:: https://codecov.io/gh/SCons/scons/branch/master/graph/badge.svg + :target: https://codecov.io/gh/SCons/scons + :alt: CodeCov Coverage Status + +About SCons +----------- + +This is SCons, a tool for building software (and other files). SCons is +implemented in Python, and its "configuration files" are actually Python +scripts, allowing you to use the full power of a real scripting language +to solve build problems. You do not, however, need to know Python to +use SCons effectively. + +Documentation +------------- + +Documentation for SCons is available at: + + http://www.scons.org/documentation.html + +Requirements +------------ + +Running SCons requires Python 3.5 or higher. There should be no other +dependencies or requirements to run SCons, although the pywin32 Python +package is strongly recommended if running on Windows systems. + + +By default, SCons knows how to search for available programming tools on +various systems--see the SCons man page for details. You may, of course, +override the default SCons choices made by appropriate configuration of +Environment construction variables. + + +Licensing +========= + +SCons is distributed under the MIT license, a full copy of which is available +in the LICENSE file. + + +Reporting Bugs +============== + +The SCons project welcomes bug reports and feature requests. + +Please make sure you send email with the problem or feature request to +the SCons users mailing list: + + Join via: http://two.pairlist.net/mailman/listinfo/scons-users + +Or the SCons Discord server #scons-help channel + + Server URL: https://discord.gg/bXVpWAy + +Once you have discussed your issue on the users mailing list and the +community has confirmed that it is either a new bug or a duplicate of an +existing bug, then please follow the instructions the community provides +to file a new bug or to add yourself to the CC list for an existing bug + +You can explore the list of existing bugs, which may include workarounds +for the problem you've run into on GitHub Issues: + + https://github.com/SCons/scons/issues + + +Mailing Lists +============= + +An active mailing list for developers of SCons is available. You may +send questions or comments to the list at: + + scons-dev@scons.org + +You may subscribe to the developer's mailing list using form on this page: + + http://two.pairlist.net/mailman/listinfo/scons-dev + +Subscription to the developer's mailing list is by approval. In practice, no +one is refused list membership, but we reserve the right to limit membership +in the future and/or weed out lurkers. + +There are other mailing lists available for SCons users, for notification of +SCons code changes, and for notification of updated bug reports and project +documents. Please see our mailing lists page for details. + + +Donations +========= + +If you find SCons helpful, please consider making a donation (of cash, +software, or hardware) to support continued work on the project. Information +is available at: + + http://www.scons.org/donate.html + +or via GitHub Sponsors button on + + https://github.com/scons/scons + + +For More Information +==================== + +Check the SCons web site at: + + http://www.scons.org/ + + +Copyright (c) 2001 - 2020 The SCons Foundation + |