diff --git a/docs/source/cordapp-plugins.rst b/docs/source/cordapp-plugins.rst deleted file mode 100644 index bbc69e66f2..0000000000 --- a/docs/source/cordapp-plugins.rst +++ /dev/null @@ -1,42 +0,0 @@ -Cordapp Plugins -=============== - -Building Plugins ----------------- - -To build the plugins that Cordapps require run the following from the root of the Corda project: - -.. code-block:: text - - ./gradlew publishToMavenLocal - -The plugins will now be installed to MavenLocal. - -Installing Plugins ------------------- - -To use the plugins, if you are not already using the Cordapp template project, you must modify your build.gradle. Add -the following segments to the relevant part of your build.gradle. - -.. code-block:: - - buildscript { - ext.corda_version = '' - ... (your buildscript) - - repositories { - ... (other repositories) - mavenLocal() - } - - dependencies { - ... (your dependencies) - classpath "com.r3corda.plugins::$corda_version" - } - } - - apply plugin: 'com.r3corda.plugins.' - - ... - -The available plugins are in the gradle-plugins directory of the Corda repository. \ No newline at end of file diff --git a/docs/source/creating-a-cordapp.rst b/docs/source/creating-a-cordapp.rst index 8f67960851..f81e15cf8a 100644 --- a/docs/source/creating-a-cordapp.rst +++ b/docs/source/creating-a-cordapp.rst @@ -122,3 +122,48 @@ In Gradle you can depend on these by adding/modifying your build.gradle file to compile "com.r3corda:corda:$corda_version" ... other dependencies here ... } + +Gradle Plugins for Cordapps +=========================== + +There are several Cordapp plugins that reduce your build.gradle boilerplate and make development of Cordapps easier. +The available plugins are in the gradle-plugins directory of the Corda repository. + +Building Gradle Plugins +----------------------- + +To build the plugins that Cordapps require run the following from the root of the Corda project: + +.. code-block:: text + + ./gradlew publishToMavenLocal + +The plugins will now be installed to MavenLocal. + +Installing Gradle Plugins +------------------------- + +To use the plugins, if you are not already using the Cordapp template project, you must modify your build.gradle. Add +the following segments to the relevant part of your build.gradle. + +.. code-block:: + + buildscript { + ext.corda_version = '' + ... (your buildscript) + + repositories { + ... (other repositories) + mavenLocal() + } + + dependencies { + ... (your dependencies) + classpath "com.r3corda.plugins::$corda_version" + } + } + + apply plugin: 'com.r3corda.plugins.' + + ... +