Skip to content

Commit 7ba3317

Browse files
committed
README.md: Refactor
Signed-off-by: Ce Gao <ce.gao@outlook.com>
1 parent f853c28 commit 7ba3317

File tree

7 files changed

+66
-30
lines changed

7 files changed

+66
-30
lines changed

docs/howto.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# HOWTO
2+
3+
### Editor Support
4+
5+
Change `processing.modes` in build.xml, and run `ant install`, you will get a mode in `processing/modes`.
6+
7+
```xml
8+
<!-- folder to install modes in (probably a folder called "modes" inside your sketchbook folder) -->
9+
<property name="processing.modes" location="/Users/<username>/Documents/Processing/modes" />
10+
<!-- path to your processing executable. -->
11+
<property name="processing.executable" location="/Applications/Processing.app/Contents/MacOS/Processing" />
12+
```
13+
14+
<img src="./docs/img/editor.png" width="600">
15+
16+
<img src="./docs/img/demo.gif" width="600">
17+
18+
### Runner.jar
19+
20+
Processing.R offers a jar, which allows to have a try without the installation of Processing app.
21+
22+
Run `ant try`, you will get a runner in `try/`, and run `java -jar ./try/RLangMode.jar <your R script>`.
23+
24+
```r
25+
posAX <- 11
26+
posAY <- 22
27+
28+
posBX <- 33
29+
posBY <- 22
30+
31+
processing$line(posAX, posAY, posBX, posBY)
32+
```
33+
34+
The output is:
35+
36+
<img src="./docs/img/demo.png" height="200">

docs/img/logo/logo.graffle

152 KB
Binary file not shown.

docs/img/logo/logo.png

101 KB
Loading

docs/img/logo/proceeesingr.svg

Lines changed: 3 additions & 0 deletions
Loading

docs/img/logo/processing-web.png

141 KB
Loading

docs/references.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# References
2+
3+
## Code
4+
5+
* [Java mode in processing main repo](https://github.com/processing/processing/tree/master/java/src/processing/mode/java)
6+
* [processing.py](https://github.com/jdf/processing.py)
7+
* [Tweak mode](https://github.com/galsasson/TweakMode)
8+
9+
## Documentation
10+
11+
* [Processing References](https://processing.org/reference/)
12+
13+
## Forum posts
14+
15+
* [GSoC 2017: R Language Mode for Processing](https://forum.processing.org/two/discussion/21195/gsoc-2017-r-language-mode-for-processing#latest)

readme.md

Lines changed: 12 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,22 @@
1-
# Processing.R [WIP]
1+
<h1 align="center">
2+
<img src="./docs/img/logo/logo.png" alt="logo" width="200">
3+
<br>
4+
</h1>
25

3-
Processing.R allows the users to write Processing sketches in R.
6+
<h4 align="center">Processing.R allows the users to write Processing sketches in R.</h4>
47

58
***Notice: Now Processing.R is still in early development stage, not production ready!***
69

7-
### Editor Support
10+
## Installation
811

9-
Change `processing.modes` in build.xml, and run `ant install`, you will get a mode in `processing/modes`.
12+
See [the documentation about the installation](./docs/howto.md).
1013

11-
```xml
12-
<!-- folder to install modes in (probably a folder called "modes" inside your sketchbook folder) -->
13-
<property name="processing.modes" location="/Users/<username>/Documents/Processing/modes" />
14-
<!-- path to your processing executable. -->
15-
<property name="processing.executable" location="/Applications/Processing.app/Contents/MacOS/Processing" />
16-
```
14+
## Feature Preview
1715

18-
<img src="./docs/img/editor.png" width="600">
16+
<img src="./docs/img/editor.png" width="500">
1917

20-
<img src="./docs/img/demo.gif" width="600">
18+
<img src="./docs/img/demo.gif" width="500">
2119

22-
### Runner.jar
20+
## Useful Resources for Development
2321

24-
Processing.R offers a jar, which allows to have a try without the installation of Processing app.
25-
26-
Run `ant try`, you will get a runner in `try/`, and run `java -jar ./try/RLangMode.jar <your R script>`.
27-
28-
```r
29-
posAX <- 11
30-
posAY <- 22
31-
32-
posBX <- 33
33-
posBY <- 22
34-
35-
processing$line(posAX, posAY, posBX, posBY)
36-
```
37-
38-
The output is:
39-
40-
<img src="./docs/img/demo.png" height="200">
22+
See [references](./docs/references.md).

0 commit comments

Comments
 (0)