-
Notifications
You must be signed in to change notification settings - Fork 8
/
add_license_badge.Rd
46 lines (43 loc) · 1.47 KB
/
add_license_badge.Rd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/add_license_badge.R
\name{add_license_badge}
\alias{add_license_badge}
\title{Add a License badge}
\usage{
add_license_badge(quiet = FALSE)
}
\arguments{
\item{quiet}{A logical value. If \code{TRUE} messages are deleted. Default is
\code{FALSE}.}
}
\value{
A badge as a markdown expression.
}
\description{
This function adds or updates the \strong{License} badge to the \code{README.Rmd}.
This function reads the \code{License} field of the \code{DESCRIPTION} file. Ensure
that this field is correctly defined. See \code{\link[=add_license]{add_license()}} for further detail.
This function requires the presence of a \code{DESCRIPTION} file at the project
root. See \code{\link[=add_description]{add_description()}} for further detail.
Make sure that 1) a \code{README.Rmd} file exists at the project root and 2) it
contains a block starting with the line \verb{<!-- badges: start -->} and ending
with the line \verb{<!-- badges: end -->}.
Don't forget to re-render the \code{README.md}.
}
\examples{
\dontrun{
add_license_badge()
}
}
\seealso{
Other adding badges:
\code{\link{add_codecov_badge}()},
\code{\link{add_cran_badge}()},
\code{\link{add_dependencies_badge}()},
\code{\link{add_github_actions_check_badge}()},
\code{\link{add_github_actions_codecov_badge}()},
\code{\link{add_github_actions_pkgdown_badge}()},
\code{\link{add_lifecycle_badge}()},
\code{\link{add_repostatus_badge}()}
}
\concept{adding badges}