Skip to content

Commit

Permalink
Add version number to user and dev guides
Browse files Browse the repository at this point in the history
 - 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
  • Loading branch information
cbeams committed Oct 9, 2014
1 parent e3a196e commit 6f1f2e3
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 5 deletions.
11 changes: 7 additions & 4 deletions docs/devguide.adoc
Original file line number Diff line number Diff line change
@@ -1,13 +1,16 @@
Bitsquare Developer Guide
=========================
Chris Beams <chris@beams.io>
:revnumber: {project-version}
:toc:
:numbered:


Introduction
------------

TODO


Build from source
-----------------

Expand Down Expand Up @@ -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]:

Expand All @@ -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.

Expand All @@ -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.

Expand Down
4 changes: 3 additions & 1 deletion docs/userguide.adoc
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
Bitsquare User Guide
====================
Chris Beams <chris@beams.io>
:revnumber: {project-version}
:toc:
:numbered:


Introduction
------------
Expand Down

0 comments on commit 6f1f2e3

Please sign in to comment.