Skip to content

Commit 6ab3f95

Browse files
authored
Refactor the documentation about docker (#177)
* *: Update readme Signed-off-by: Ce Gao <[email protected]> * compilation: Add one line Signed-off-by: Ce Gao <[email protected]>
1 parent 32b97ae commit 6ab3f95

File tree

3 files changed

+11
-6
lines changed

3 files changed

+11
-6
lines changed

raw-docs/devel/compilation.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -117,17 +117,22 @@ The output is:
117117

118118
## Docker Image (DEPRECATED)
119119

120-
The docker image of Processing.R is currently deprecated.
120+
[![Docker Repository on Quay](https://quay.io/repository/gaocegege/processing.r/status "Docker Repository on Quay")](https://quay.io/repository/gaocegege/processing.r)
121121

122-
Docker containers provide a lightweight virtual environments that package up Linux applications with everything that they need to run.
122+
**NOTICE:** The docker image of Processing.R is currently deprecated, since graphic card is not fully supported in Docker. 3D sketches couldn't work in the docker container.
123+
124+
Docker containers provide a lightweight virtual environment that package up Linux applications with everything that they need to run.
123125

124126
In order to install a docker image and then launch a docker container of Processing.R running in a virtual Linux desktop environment:
125127

126128
1. install docker on your system
127129
1. `docker pull quay.io/gaocegege/processing.r`
128130
1. `docker run quay.io/gaocegege/processing.r`
129-
1. open the link of NoVNC in a web browser.
130-
1. input the default password `process`in the URL
131+
1. open the link of NoVNC `http://<IP of the container>:6901/vnc_auto.html?password=process` in a web browser.
131132
1. play with Processing.R in a desktop environment :)
132133

133-
See [the demo in vimeo](https://vimeo.com/207571123)
134+
See the video in vimeo:
135+
136+
<div align="center">
137+
<a href="https://vimeo.com/225961911"><img src="../img/video.png" alt="Demo in Vimeo" width="600"></a>
138+
</div>

raw-docs/img/video.png

287 KB
Loading

readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<p align="center">
99
<a href="https://travis-ci.org/gaocegege/Processing.R"><img src="https://travis-ci.org/gaocegege/Processing.R.svg?branch=master" alt="Travis CI"></a>
1010
<a href="https://ci.appveyor.com/project/gaocegege/processing-r/branch/master"><img src="https://ci.appveyor.com/api/projects/status/9lq6psaw9c18ins8/branch/master?svg=true" alt="appveyor"></a>
11-
<a href="https://quay.io/repository/gaocegege/processing.r"><img src="https://img.shields.io/badge/docker-deprecated-yellowgreen.svg" alt=""></a>
11+
<a href="https://github.com/gaocegege/Processing.R/blob/master/raw-docs/devel/compilation.md#docker-image-deprecated"><img src="https://img.shields.io/badge/docker-deprecated-yellowgreen.svg" alt=""></a>
1212
<!--<a href="https://quay.io/repository/gaocegege/processing.r"><img src="https://quay.io/repository/gaocegege/processing.r/status" alt="Docker Repository on Quay" title="Docker Repository on Quay"></a>-->
1313
<a href="https://www.codacy.com/app/gaocegege/Processing-R?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=gaocegege/Processing.R&amp;utm_campaign=Badge_Grade"><img src="https://api.codacy.com/project/badge/Grade/33ebc49f6f764fffb7ea7bf617edf902" alt="Codacy Badge"></a>
1414
<!--<a href="https://www.codacy.com/app/gaocegege/Processing-R?utm_source=github.com&amp;utm_medium=referral&amp;utm_content=gaocegege/Processing.R&amp;utm_campaign=Badge_Coverage"><img src="https://api.codacy.com/project/badge/Coverage/33ebc49f6f764fffb7ea7bf617edf902" alt="Codacy Badge"></a>-->

0 commit comments

Comments
 (0)