Skip to content

Commit 07808d4

Browse files
committed
Updated documentation
1 parent b02df92 commit 07808d4

File tree

2 files changed

+31
-1
lines changed

2 files changed

+31
-1
lines changed
+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
Spaghetti Haxe Gradle Plugin
2+
============================
3+
4+
## Basic usage
5+
6+
You can apply the Spaghetti Haxe plugin by:
7+
8+
```groovy
9+
buildscript {
10+
repositories {
11+
mavenCentral()
12+
}
13+
14+
dependencies {
15+
classpath "com.prezi.spaghetti:gradle-spaghetti-haxe-plugin:1.4.1"
16+
}
17+
}
18+
19+
apply plugin: "spaghetti-haxe"
20+
```
21+
22+
It does the following things:
23+
24+
* Applies the [gradle-spaghetti-plugin](../gradle-spaghetti-plugin)
25+
* Applies the [gradle-haxe-plugin](https://github.com/prezi/gradle-haxe-plugin) without creating tasks
26+
* Sets Spaghetti's target platform to `haxe`
27+
* Creates the `js` Haxe target platform
28+
* Makes sure the all `test` configurations have access to dependent modules
29+
* Configures the Haxe plugin to include generated Spaghetti sources when compiling and testing artifacts, and when creating the source bundles
30+
* Creates special tasks for compilation and MUnit testing that work with Spaghetti modules

gradle-spaghetti-plugin/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ buildscript {
1212
}
1313
1414
dependencies {
15-
classpath "com.prezi.spaghetti:gradle-spaghetti-plugin:1.4"
15+
classpath "com.prezi.spaghetti:gradle-spaghetti-plugin:1.4.1"
1616
}
1717
}
1818

0 commit comments

Comments
 (0)