From 6f1f2e30c336fdf12ee8e949e51b60af4f9bbac3 Mon Sep 17 00:00:00 2001 From: Chris Beams Date: Tue, 7 Oct 2014 11:38:52 +0200 Subject: [PATCH] Add version number to user and dev guides - Assign ":revnumber:" header attribute using the {project-version} attribute automatically passed into asciidoctor by the Gradle plugin. - Also configure headings to render with numbers using the ":numbered:" header attribute. See #91 --- docs/devguide.adoc | 11 +++++++---- docs/userguide.adoc | 4 +++- 2 files changed, 10 insertions(+), 5 deletions(-) diff --git a/docs/devguide.adoc b/docs/devguide.adoc index 1fa6ea23f7d..266c969a56b 100644 --- a/docs/devguide.adoc +++ b/docs/devguide.adoc @@ -1,13 +1,16 @@ Bitsquare Developer Guide ========================= -Chris Beams +:revnumber: {project-version} :toc: +:numbered: + Introduction ------------ TODO + Build from source ----------------- @@ -48,7 +51,7 @@ TIP: Here are http://www.webupd8.org/2014/03/how-to-install-oracle-java-8-in-deb === Steps -==== 1. Get the source +==== Get the source The preferred approach is to clone the Bitsquare repository using http://www.git-scm.com/[git]: @@ -57,7 +60,7 @@ The preferred approach is to clone the Bitsquare repository using http://www.git However, if you're not familiar with git or it is otherwise inconvenient to use, you can also download and extract a zip file of the latest sources at https://github.com/bitsquare/bitsquare/archive/master.zip. -==== 2. Build +==== Build everything Bitsquare uses http://www.gradle.org/[Gradle], and the http://www.gradle.org/docs/current/userguide/gradle_wrapper.html[Gradle wrapper] as a build system. This means you don't need to download or do anything other than run the following command within the `bitsquare` directory. @@ -66,7 +69,7 @@ Bitsquare uses http://www.gradle.org/[Gradle], and the http://www.gradle.org/doc NOTE: on Windows, leave out the `./` and simply run `gradlew build`. -==== 3. Run +==== Run the installer When the build completes, you'll find executables and installers in the `build/distributions` directory. diff --git a/docs/userguide.adoc b/docs/userguide.adoc index 6446cb22827..93d74a0c652 100644 --- a/docs/userguide.adoc +++ b/docs/userguide.adoc @@ -1,7 +1,9 @@ Bitsquare User Guide ==================== -Chris Beams +:revnumber: {project-version} :toc: +:numbered: + Introduction ------------