Skip to content

Commit b5e3bc9

Browse files
docs: Add help for resources generate commands
1 parent 5a97228 commit b5e3bc9

File tree

3 files changed

+60
-3
lines changed

3 files changed

+60
-3
lines changed
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
<% if (isJekyll) { %>---
2+
title: tns resources generate icons
3+
position: 11
4+
---<% } %>
5+
# tns resources generate icons
6+
7+
Usage | Synopsis
8+
------|-------
9+
`$ tns resources generate icons <Path to image>` | Generate all icons for Android and iOS based on the specified image.
10+
11+
Generates all icons for Android and iOS platforms and places the generated images in the correct directories under `App_Resources/<platform>` directory.
12+
13+
### Attributes
14+
* `<Path to image>` is a valid path to an image that will be used to generate all icons.
15+
16+
<% if(isHtml) { %>
17+
### Related Commands
18+
19+
Command | Description
20+
----------|----------
21+
[install](../install.html) | Installs all platforms and dependencies described in the `package.json` file in the current directory.
22+
[platform add](../platform-add.html) | Configures the current project to target the selected platform.
23+
[platform remove](../platform-remove.html) | Removes the selected platform from the platforms that the project currently targets.
24+
[platform](../platform.html) | Lists all platforms that the project currently targets.
25+
[prepare](../prepare.html) | Copies common and relevant platform-specific content from the app directory to the subdirectory for the selected target platform in the platforms directory.
26+
[resources update](resources-update.md) | Updates the `App_Resources/Android` internal folder structure to conform to that of an Android Studio project.
27+
[resources generate splashes](resources-generate-splashes.md) | Generates splashscreens for Android and iOS.
28+
<% } %>
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<% if (isJekyll) { %>---
2+
title: tns resources generate splashes
3+
position: 12
4+
---<% } %>
5+
# tns resources generate splashes
6+
7+
Usage | Synopsis
8+
------|-------
9+
`$ tns resources generate splashes <Path to image> [<background>]` | Generate all splashscreens for Android and iOS based on the specified image.
10+
11+
Generates all icons for Android and iOS platforms and places the generated images in the correct directories under `App_Resources/<platform>` directory.
12+
13+
### Attributes
14+
* `<Path to image>` is a valid path to an image that will be used to generate all splashscreens.
15+
* `<background>` is a valid path to an image that will be used as a background of the splashscreen. Defaults to white in case it is not specified.
16+
17+
<% if(isHtml) { %>
18+
### Related Commands
19+
20+
Command | Description
21+
----------|----------
22+
[install](../install.html) | Installs all platforms and dependencies described in the `package.json` file in the current directory.
23+
[platform add](../platform-add.html) | Configures the current project to target the selected platform.
24+
[platform remove](../platform-remove.html) | Removes the selected platform from the platforms that the project currently targets.
25+
[platform](../platform.html) | Lists all platforms that the project currently targets.
26+
[prepare](../prepare.html) | Copies common and relevant platform-specific content from the app directory to the subdirectory for the selected target platform in the platforms directory.
27+
[resources update](resources-update.md) | Updates the `App_Resources/Android` internal folder structure to conform to that of an Android Studio project.
28+
[resources generate icons](resources-generate-icons.md) | Generates icons for Android and iOS.
29+
<% } %>

docs/man_pages/project/configuration/resources/resources-update.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<% if (isJekyll) { %>---
22
title: tns resources update
3-
position: 9
3+
position: 10
44
---<% } %>
5-
#tns resources update
5+
# tns resources update
66
==========
77

88
Usage | Synopsis
@@ -11,7 +11,7 @@ Usage | Synopsis
1111
`$ tns resources update android` | Updates the App_Resources/Android's folder structure.
1212

1313
Updates the App_Resources/<platform>'s internal folder structure to conform to that of an Android Studio project. Android resource files and directories will be located at the following paths:
14-
- `drawable-*`, `values`, `raw`, etc. can be found at `App_Resources/Android/src/main/res`
14+
- `drawable-*`, `values`, `raw`, etc. can be found at `App_Resources/Android/src/main/res`
1515
- `AndroidManifest.xml` can be found at `App_Resources/Android/src/main/AndroidManifest.xml`
1616
- Java source files can be dropped in at `App_Resources/Android/src/main/java` after creating the proper package subdirectory structure
1717
- Additional arbitrary assets can be dropped in at `App_Resources/Android/src/main/assets`

0 commit comments

Comments
 (0)