https://github.com/ptomulik/scons-gnu-package
Define installable packages in your scons-based projects.
https://github.com/ptomulik/scons-gnu-package
Last synced: 3 months ago
JSON representation
Define installable packages in your scons-based projects.
- Host: GitHub
- URL: https://github.com/ptomulik/scons-gnu-package
- Owner: ptomulik
- License: mit
- Created: 2012-11-03T22:42:18.000Z (over 12 years ago)
- Default Branch: master
- Last Pushed: 2012-11-06T03:31:07.000Z (over 12 years ago)
- Last Synced: 2025-01-18T02:28:49.467Z (5 months ago)
- Language: Python
- Size: 129 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
SConsGnuPackage
===============
Welcome to SConsGnuPackage.
This package provides an easy way to define installable packages in your
scons-based project. It allows you to describe one or more packages that you
wish to create from your source tree and generate necessary scons targets
auto-magically.
INSTALLATION
------------
Just copy entire directory ``SConsGnuPackage`` to your local ``site_scons``
directory. You'll also need additional packages to use ``SConsGnuPackage``.
DOWNLOADING DEPENDENCIES
------------------------
This package is not self-contained and have some external dependencies (see
[REQUIREMENTS](#requirements)). The first step after downloading the
``scons-gnu-package`` source tree is to download necessary dependencies.
### Downloading dependencies needed to use SConsGnuPackage
If you have ``sh``-compatible shell, just run the
tools/download-user-deps.sh
script from the top-level source directrory. It will download necessary python
packages into ``site_scons`` directory. The script uses ``wget`` and ``tar``
programs.
### Downloading dependencies needed to develop SConsGnuPackage
If you have th ``sh``-compatible shell, just run the
tools/download-devel-deps.sh
script from top-level dir of your source tree. The script uses ``wget`` and
``tar`` programs.
REQUIREMENTS
------------
### Packages that SConsGnuPackage depends on
The ``SConsGnuPackage`` needs following external packages to function properly:
* SConsGnuVariables
The ``SConsGnuVariables`` is installed by ``tools/download-user-deps.sh``.
### Software needed to generate documentation
To generate user documentation you'll need:
* docbook-xml
* xsltproc
* scons docbook tool
The scons docbook tool is installed by ``tools/download-devel-deps.sh``.
To generate API documentation you'll need at least:
* epydoc
* python-docutils
* python-pygments
Install these packages with your package manager.
DOCUMENTATION
-------------
### User's documentation
User's documentation may be generated with
scons user-doc
You'll find generated files under ``build/doc/user/``.
### API documentation
API documentation may be generated with
scons api-doc
You'll find generated files under ``build/doc/api/``.
LICENSE
-------
Copyright (c) 2012 by Pawel Tomulik
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE