Debian Codegraph @

script/README.md

raw
1 # Introduction
2
3 This folder contains scripts that represent common tasks a developer (or CI)
4 needs to perform when getting started with the project.
5
6 The scripts are loosely based on the model described by
7 [Github](https://github.blog/2015-06-30-scripts-to-rule-them-all/)
8
9
10 # Scripts
11
12 - `bootstrap` - Build the project dependencies.
13
14 - `build` - Build the project and place output in `_build`. Also install to
15 staging area `_install`.
16
17 - `test` - Run basic smoke testing on built project. Scope can be limited by
18 providing subset of tests as argument from among: lint, unit
19
20 - `install` - Install the project built in the build stage. If argument is
21 provided then it will be interpreted as the install prefix. If called without
22 arguments then installation will be to `VPL_INSTALL_DIR` if defined or system
23 default location otherwise.
24
25
26 **LEGAL NOTICE: By downloading and using any scripts (the “Software Package”)
27 and the included software or software made available for download, you agree to
28 the terms and conditions of the software license agreements for the Software
29 Package, which may also include notices, disclaimers, or license terms for third
30 party software (together, the “Agreements”) included in this README file. If
31 the Software Package is installed through a silent install, your download and
32 use of the Software Package indicates your acceptance of the Agreements.**