From ed56243ab93a9beca9743d8340195aef78a5ef92 Mon Sep 17 00:00:00 2001 From: Mats Wichmann Date: Thu, 2 Dec 2021 09:07:41 -0700 Subject: Harmonize pypi readme with github readme [ci skip] The two are now back in sync and have only small differences. Signed-off-by: Mats Wichmann --- README-package.rst | 154 ++++++++++++++++++++++++++++++++++++----------------- README.rst | 21 ++++++-- 2 files changed, 122 insertions(+), 53 deletions(-) diff --git a/README-package.rst b/README-package.rst index f9833f7..61efa1e 100755 --- a/README-package.rst +++ b/README-package.rst @@ -1,4 +1,4 @@ -SCons - a software construction tool +SCons - a Software Construction Tool #################################### .. image:: https://img.shields.io/badge/IRC-scons-blue.svg @@ -25,39 +25,111 @@ SCons - a software construction tool :target: https://codecov.io/gh/SCons/scons :alt: CodeCov Coverage Status -About SCons ------------ +.. image:: https://github.com/SCons/scons/workflows/SCons%20Build/badge.svg + :target: https://github.com/SCons/scons/actions?query=workflow%3A%22SCons+Build%22 + :alt: Github Actions + + +What is SCons? +============== + +SCons is an Open Source software construction tool which orchestrates the construction of software +(and other tangible products such as documentation files) by determining which +component pieces must be built or rebuilt and invoking the necessary +commands to build them. + + +Features: + + * Configuration files are Python scripts - + use the power of a real programming language + to solve build problems; no complex domain-specific language to learn. + * Reliable, automatic dependency analysis built-in for C, C++ and Fortran. + No more "make depend" or "make clean" to get all of the dependencies. + Dependency analysis is easily extensible through user-defined + dependency Scanners for other languages or file types. + * Built-in support for C, C++, D, Java, Fortran, Yacc, Lex, Qt and SWIG, + and building TeX and LaTeX documents. + Easily extensible through user-defined Builders for other languages + or file types. + * Building from central repositories of source code and/or pre-built targets. + * Built-in support for Microsoft Visual Studio, including generation of + .dsp, .dsw, .sln and .vcproj files. + * Reliable detection of build changes using cryptographic hashes; + optionally can configure other algorithms including traditional timestamps. + * Support for parallel builds - can keep multiple jobs running + simultaneously regardless of directory hierarchy. + * Integrated Autoconf-like support for finding #include files, libraries, + functions and typedefs. + * Global view of all dependencies - no more multiple build passes or + reordering targets to build everything. + * Ability to share built files in a cache to speed up multiple builds. + * Designed from the ground up for cross-platform builds, and known to + work on Linux, other POSIX systems (including AIX, BSD systems, + HP/UX, IRIX and Solaris), Windows 7/8/10, MacOS, and OS/2. + * Written in Python. -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. -Documentation for SCons is available at: - http://www.scons.org/documentation.html +Execution Requirements +====================== -Requirements ------------- +Running SCons requires Python 3.6 or higher. There should be no other +dependencies or requirements to run standard SCons. +The last release to support Python 3.5 was 4.2.0. -Running SCons requires Python 3.5 or higher. There should be no other -dependencies or requirements to run SCons. +Some experimental features may require additional Python packages +to be installed - at the moment the Ninja feature requires the +supporting `ninja package `_. -As of SCons 4.2.0 support for Python 3.5 is deprecated and will be removed -with the next major release. +The default SCons configuration assumes use of the Microsoft Visual C++ +compiler suite on Win32 systems, and assumes a C compiler named ``cc``, a C++ +compiler named ``c++``, and a Fortran compiler named ``gfortran`` (such as found +in the GNU Compiler Collection) on any other type of system. You may +override these default values by appropriate configuration of variables +in a Construction Environment, or in the case of Cygwin on a Win32 system, +by selecting the 'cygwin' platform, which will set some of those Construction +Variables for you. 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. +various systems - see the +`SCons man page `_ +for details. You can override +the default SCons choices made by appropriate configuration of +construction variables. -Licensing -========= +Installation Requirements +========================= + +SCons has no installation dependencies beyond a compatible version +of Python. The tools which will be used to to actually construct the +project, such as compilers, documentation production tools, etc. +should of course be installed by the appropriate means. + + +Getting Started Using SCons +=========================== + +If you're new to SCons, the first couple of chapters of the +`SCons User Guide `_ +provide an excellent starting spot. + + +Contributing to SCons +===================== + +Please see `CONTRIBUTING `_. + + +License +======= SCons is distributed under the MIT license, a full copy of which is available in the LICENSE file. @@ -69,13 +141,10 @@ 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 +the SCons users mailing list, which you can join at +https://two.pairlist.net/mailman/listinfo/scons-users, +or on the SCons Discord server in +`#scons-help `_. 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 @@ -83,22 +152,18 @@ 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 +for the problem you've run into, on the +`GitHub issue tracker `_. Mailing Lists ============= An active mailing list for developers of SCons is available. You may -send questions or comments to the list at: +send questions or comments to the list at scons-dev@scons.org. - 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 +You may subscribe to the developer's mailing list using the form at +https://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 @@ -114,21 +179,14 @@ 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 +is available at https://www.scons.org/donate.html +or the GitHub Sponsors button on https://github.com/scons/scons. For More Information ==================== -Check the SCons web site at: - - http://www.scons.org/ +Check the SCons web site at https://www.scons.org/ Copyright (c) 2001 - 2021 The SCons Foundation diff --git a/README.rst b/README.rst index f4370cf..97392ec 100755 --- a/README.rst +++ b/README.rst @@ -70,6 +70,13 @@ Features: * Written in Python. +Documentation +============= + +Documentation for SCons is available at +http://www.scons.org/documentation.html. + + Latest Version ============== @@ -87,7 +94,7 @@ The last release to support Python 3.5 was 4.2.0. Some experimental features may require additional Python packages to be installed - at the moment the Ninja feature requires the -supporting ninja package. +supporting `ninja package `_. The default SCons configuration assumes use of the Microsoft Visual C++ compiler suite on Win32 systems, and assumes a C compiler named ``cc``, a C++ @@ -197,7 +204,9 @@ 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, which you can join at -https://two.pairlist.net/mailman/listinfo/scons-users +https://two.pairlist.net/mailman/listinfo/scons-users, +or on the SCons Discord server in +`#scons-help `_. 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 @@ -205,16 +214,18 @@ 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. +for the problem you've run into, on the +`GitHub issue tracker `_. 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 +send questions or comments to the list at scons-dev@scons.org. -You may subscribe to the developer's mailing list using form at https://two.pairlist.net/mailman/listinfo/scons-dev +You may subscribe to the developer's mailing list using the form at +https://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 -- cgit v0.12