ExternalVendorCode/corda
1
0
Fork 0
mirror of https://github.com/corda/corda.git synced 2025-01-18 02:39:51 +00:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

put some version related notes in the readme

Browse Source
This commit is contained in:
ben 2019-03-22 11:59:19 +00:00 committed by Mike Hearn
parent 803ea3e652
commit 8ac4b33b08
1 changed files with 19 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
docs/README.md
View File

@ -12,3 +12,22 @@ agent, make sure the relevant drive is shared, and click 'Reset credentials'.
It's probably worth reading [this](http://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html)
to get your head around the rst syntax we're using.
## version placeholders
Currently we support five placeholders that get substituted at build time:
```groovy
"|corda_version|"
"|java_version|"
"|kotlin_version|"
"|gradle_plugins_version|"
"|quasar_version|"
```
If you put one of these in an rst file anywhere (including in a code tag) then it will be substituted with the value in constants.properties
(which is in the root of the project) at build time.
The code for this can be found near the top of the conf.py file in the `docs/source` directory.