ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2025-06-17 14:48:16 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Moved the plugins docs into the creating a cordapp doc.

Browse Source
This commit is contained in:
Clinton Alexander
2016-10-10 12:25:50 +01:00
parent 6dd29981dd
commit efb4629a44
2 changed files with 45 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
docs/source/cordapp-plugins.rst
View File

@ -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 = '<enter the corda version you build against here>'
... (your buildscript)
repositories {
... (other repositories)
mavenLocal()
}
dependencies {
... (your dependencies)
classpath "com.r3corda.plugins:<plugin-maven-name>:$corda_version"
}
}
apply plugin: 'com.r3corda.plugins.<plugin-maven-name>'
...
The available plugins are in the gradle-plugins directory of the Corda repository.

45
docs/source/creating-a-cordapp.rst
View File

@ -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" compile "com.r3corda:corda:$corda_version"
... other dependencies here ... ... 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 = '<enter the corda version you build against here>'
... (your buildscript)
repositories {
... (other repositories)
mavenLocal()
}
dependencies {
... (your dependencies)
classpath "com.r3corda.plugins:<plugin-maven-name>:$corda_version"
}
}
apply plugin: 'com.r3corda.plugins.<plugin-maven-name>'
...