Skip to content

Commit 5e905a1

Browse files
authored
Update README.md
1 parent 24588f4 commit 5e905a1

1 file changed

Lines changed: 44 additions & 0 deletions

File tree

README.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,8 +34,52 @@ Run `npm i -g @electron-forge/cli` in your terminal to install electron in your
3434

3535
Packages used in your application not available at CRAN should be installed at your computer.
3636

37+
## How to use
38+
39+
Run `executablePackeR::pack()` at the same directory of your app.R
40+
41+
To check where you are, run `getwd()`.
42+
43+
For example, if your 'app.R' is located at "/Users/ChangwooLim/Desktop/my-app/app.R", you should run `executablePackeR::pack()` at "/Users/ChangwooLim/Desktop/my-app".
44+
3745
## Options
3846

47+
You can pass some parameters to adjust settings.
48+
49+
### App Name
50+
51+
You can pass app name like below. If you don't set, default is "myapp"
52+
53+
```
54+
executablePackeR::pack(
55+
#' app_name = "myapp",
56+
#' [... more options]
57+
#' )
58+
```
59+
60+
### Electron Settings
61+
62+
Electron Settings are passed like below.
63+
64+
You can pass 5 parameters. If you don't pass anything, below is default.
65+
66+
The most important option is 'product_name_template', because it shows on the program window.
67+
68+
Now, version is fixed to '0.0.1'. It will be available to change version soon.
69+
70+
```
71+
#' executablePackeR::pack(
72+
#' electron_settings = list(
73+
#' c("product_name_template", "My Own Product Name"),
74+
#' c("app_description_template", "App Description"),
75+
#' c("author_name_template", "Author Name"),
76+
#' c("author_email_template", "Author E-mail"),
77+
#' c("repository_url_template", "Repository URL")
78+
#' ),
79+
#' [... more options]
80+
#' )
81+
```
82+
3983
### Icons
4084

4185
You can apply your custom icons. However, some limitations apply.

0 commit comments

Comments
 (0)