Commit f29ec718 authored by Julien Veyssier's avatar Julien Veyssier
Browse files

README baby

parent 8c1d7909
......@@ -12,11 +12,10 @@ The execution of the R CMD CHECK can be parallelized by giving the corresponding
XVFB is used to perform graphical actions even without being under a running X server. JQuery is used to present check results.
There is basically three ways to use R package checker :
There are basically two ways to use R package checker :
* Call the Bash script directly, watch the output and read .Rout files
* Call the Bash script directly with the --html option to produce a real-time html output including all .Rout outputs
* Setup the Php files and adapt values in config.php to manage test launch and results viewing in the basic web interface
* Call the Bash script directly, watch the output and read .Rout files **OR** watch the real-time html output including all .Rout outputs
* Deploy the Php files and adapt values in config.php to manage test launch and results viewing in the basic web interface
## Table of content
---
......@@ -30,18 +29,20 @@ There is basically three ways to use R package checker :
# Screenshots
---
Bash script output :
**Bash script output :**
![screenshot bash](https://gitlab.com/eneiluj/r-package-checker/raw/master/screenshots/rcheck_bash.png)
---
Simple web interface examples :
**Simple web interface example with 3 parallel processes :**
![screenshot web](https://gitlab.com/eneiluj/r-package-checker/raw/master/screenshots/rcheck_web.png)
---
**Something went wrong in plotKML check procedure :**
![screenshot web problem](https://gitlab.com/eneiluj/r-package-checker/raw/master/screenshots/rcheck_web_problem.png)
# Requirements
......
Markdown is supported
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