Commit 59aa1c13 authored by Jean-Francois Rey's avatar Jean-Francois Rey
Browse files

update description and readme

parent a8d43bc4
......@@ -5,7 +5,7 @@ Title: R Template Package
Version: 0.1.0
Date: 2019-11-05
Authors@R: person("Jean-Francois", "Rey", role = c("aut","cre"), email = "jean-francois.rey@inra.fr")
Author: Jean-Francois Rey [aut, aut]
Author: Jean-Francois Rey [aut, cre]
Maintainer: Jean-Francois Rey <jean-francois.rey@inra.fr>
Description: A R package template to manage the package and the CI/CD pipeline.
URL: https://gitlab.paca.inra.fr/r-ecosystem/cookbooks/r-packages-ci-cd
......
......@@ -48,7 +48,7 @@ There are severals version of this project, depending if the package need compil
* __[.Rbuildignore](.Rbuildignore)__ : regex for files to not include in package
* __[R/](R)__ : R source code directory
* __[man/](man)__ : documentation directory generated by roxygen2
* __[test/](tests)__ : testthat direcotry, instruction for tests
* __[test/](tests)__ : testthat directory, instruction for tests
* __[inst/](inst)__ : directory of files to add in package at install
* __[LICENSE](LICENSE)__ : the license file
......@@ -62,7 +62,7 @@ There are severals version of this project, depending if the package need compil
* Then it run tests
* And finally build binaries packages
## set up GitLab
## Set up GitLab
### The project repository
......@@ -86,7 +86,7 @@ Check _tags_ in [.gilab-ci.yml](.gitlab-ci.yml) file to enable the runner needed
This runners come with pre-installer R packages, R tools and system-libraries (bin and dev).
See [here](https://gitlab.paca.inra.fr/r-ecosystem/r-docker-images/blob/master/r-base-biosp/Dockerfile) for more informations.
If you need you can add your own runner or ask GitLab administrator to set up a new one.
If you need, you can add your own runner or ask GitLab administrator to set up a new one.
## The .gitlab-ci.yml file
......@@ -96,7 +96,7 @@ It set up three stages (create, tests and build) and severals jobs by stages.
* create : update Description, NAMESPACE, and man (roxygen2). Create the package.
* tests : Test the package (--as-cran)
* build : Build the package source tar.gz and binary version for MacOS (.tgz) and Windows (.zip)
* build : Build the package source tar.gz and binary version for MacOS (.tgz) and Windows (.zip) only with commit is tagger.
You need to set up this file for your project.
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment