-
Notifications
You must be signed in to change notification settings - Fork 18
/
install-file.Rmd
21 lines (17 loc) · 1.04 KB
/
install-file.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
# The INSTALL file {#sysdep}
An INSTALL file does not have to be included with the package. An INSTALL file
is utilized for specifying external system requirements needed. It should be
used in combination with the `SystemRequirements` field of the [Description
file](#description-sysdep). This file should provide instructions for installing
the external software on the 3 major OS that we support: Linux, Windows, and
Mac. This will not only help your users get the external software on their
machines, but it will also help us install it on the build machines if it's not
already there.
Specifying this requirement does not guarantee that _Bioconductor_ will agree to
install the external system requirement. It is encouraged to discuss any
additional system requirements on the [email protected] before
development.
System requirements should never be exclusive to a particular
version. Maintainers are expected to have their package work with whatever the
current version of external software is available.
See also [third party code](#third-party-code)