Skip to content

Commit f55bee4

Browse files
committed
Added more info to the contribution section of README doc
1 parent ecc74b6 commit f55bee4

File tree

1 file changed

+57
-16
lines changed

1 file changed

+57
-16
lines changed

README.md

Lines changed: 57 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ In-app Review Plugin provides access to in-app review functionality for Google P
2929

3030
---
3131

32-
<a name="installation">
32+
<a name="installation"></a>
3333

3434
## <img src="addon/icon.png" width="20"> Installation
3535

@@ -52,7 +52,7 @@ If using both Android & iOS, ensure **same addon interface version**.
5252

5353
---
5454

55-
<a name="usage">
55+
<a name="usage"></a>
5656

5757
## <img src="addon/icon.png" width="20"> Usage
5858
Add an `InappReview` node to your scene and follow the following steps:
@@ -65,14 +65,14 @@ Add an `InappReview` node to your scene and follow the following steps:
6565

6666
---
6767

68-
<a name="demo">
68+
<a name="demo"></a>
6969

7070
## <img src="addon/icon.png" width="20"> Demo
7171
The demo app's only purpose is to provide sample code. Since the demo app is not registered with the Google Play store or App Store, the in-app review dialog will not be displayed.
7272

7373
---
7474

75-
<a name="signals">
75+
<a name="signals"></a>
7676

7777
## <img src="addon/icon.png" width="20"> Signals
7878

@@ -83,7 +83,7 @@ The demo app's only purpose is to provide sample code. Since the demo app is not
8383

8484
---
8585

86-
<a name="platform-specific-notes">
86+
<a name="platform-specific-notes"></a>
8787

8888
## <img src="addon/icon.png" width="20"> Platform-Specific Notes
8989

@@ -103,7 +103,7 @@ The demo app's only purpose is to provide sample code. Since the demo app is not
103103

104104
---
105105

106-
<a name="links">
106+
<a name="links"></a>
107107

108108
# <img src="addon/icon.png" width="20"> Links
109109

@@ -133,7 +133,7 @@ The demo app's only purpose is to provide sample code. Since the demo app is not
133133

134134
---
135135

136-
<a name="credits">
136+
<a name="credits"></a>
137137

138138
# <img src="addon/icon.png" width="24"> Credits
139139

@@ -145,14 +145,25 @@ Original repository: [Godot In-app Review Plugin](godot-sdk-integrations/godot-i
145145

146146
---
147147

148-
<a name="contributing">
148+
<a name="contributing"></a>
149149

150150
# <img src="addon/icon.png" width="24"> Contributing
151151

152152
This section provides information on how to build the plugin for contributors.
153153

154154
---
155155

156+
## Common Configuration
157+
158+
The `common/config.properties` file allows for the configuration of:
159+
160+
- The name of the main plugin node in Godot
161+
- Plugin version
162+
- Version of Godot that the plugin depends on
163+
- Release type of the Godot version to download (ie. stable, dev6, or beta3)
164+
165+
---
166+
156167
## <img src="addon/icon.png" width="20"> iOS
157168

158169
### Prerequisites
@@ -162,20 +173,41 @@ This section provides information on how to build the plugin for contributors.
162173

163174
---
164175

176+
### iOS Configuration
177+
178+
Among other settings, the `ios/config/config.properties` file allows for the configuration of:
179+
180+
- The target iOS platform version
181+
- Valid/compatible Godot versions
182+
183+
---
184+
165185
### Build
166186

167-
- Run `./script/build.sh -A <godot version>` initially to run a full build
168-
- Run `./script/build.sh -cgA <godot version>` to clean, redownload Godot, and rebuild
169-
- Run `./script/build.sh -ca` to clean and build without redownloading Godot
170-
- Run `./script/build.sh -cb -z4.0` to clean and build plugin without redownloading Godot and package in a zip archive as version 4.0
171-
- Run `./script/build.sh -h` for more information on the build script
187+
#### Build All and Create Release Archives for Both Platforms
188+
189+
- Run `./script/build.sh -R` -- creates all 3 archives in the `./release` directory
190+
191+
#### iOS Builds
192+
iOS build script can be run directly as shown in the examples below.
193+
194+
- Run `./ios/script/build.sh -A` initially to run a full build
195+
- Run `./ios/script/build.sh -cgA` to clean, redownload Godot, and rebuild
196+
- Run `./ios/script/build.sh -ca` to clean and build without redownloading Godot
197+
- Run `./ios/script/build.sh -cbz` to clean and build plugin without redownloading Godot and package in a zip archive
198+
- Run `./ios/script/build.sh -h` for more information on the build script
199+
200+
Alternatively, iOS build script can be run through the root-level build script as follows
201+
202+
- Run `./script/build.sh -i -- -cbz` to clean and build plugin without redownloading Godot and package in a zip archive
203+
- Run `./script/build.sh -i -- -h` for more information on the build script
172204

173205
___
174206

175207
## <img src="addon/icon.png" width="20"> Install Script
176208

177-
- Run `./script/install.sh -t <target directory> -z <path to zip file>` install plugin to a Godot project.
178-
- Example `./script/install.sh -t demo -z build/release/DeeplinkPlugin-v4.0.zip` to install to demo app.
209+
- Run `./ios/script/install.sh -t <target directory> -z <path to zip file>` install plugin to a Godot project.
210+
- Example `./ios/script/install.sh -t demo -z build/release/ThisPlugin-v4.0.zip` to install to demo app.
179211

180212
___
181213

@@ -187,6 +219,15 @@ Library archives will be created in the `build/release` directory.
187219

188220
## <img src="addon/icon.png" width="20"> Android
189221

222+
---
223+
224+
### Android Configuration
225+
226+
The `android/gradle/lib.versions.toml` contains:
227+
228+
- Gradle plugins and their versions
229+
- Library dependencies and their versions
230+
190231
### Build
191232

192233
**Options:**
@@ -195,4 +236,4 @@ Library archives will be created in the `build/release` directory.
195236
- Run **packageDistribution** task to create release archive
196237
2. Use project-root-level **build.sh** script
197238
- `./script/build.sh -ca` - clean existing build, do a debug build for Android
198-
- `./script/build.sh -carz` - clean existing build, do a release build for Android, and create archive
239+
- `./script/build.sh -carz` - clean existing build, do a release build for Android, and create release archive in the `android/<plugin-name>/build/dist` directory

0 commit comments

Comments
 (0)