Skip to content

Commit 5cd2340

Browse files
committed
Updated README
1 parent 56ad553 commit 5cd2340

File tree

1 file changed

+23
-9
lines changed

1 file changed

+23
-9
lines changed

README.adoc

Lines changed: 23 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
= gitbucket-asciidoctor-plugin
2-
:plugin-version: 1.0.2
2+
:plugin-version: 1.1.1
33
:scala-version: 2.12
4-
:gitbucket-bincompat-version: 4.10
5-
:gitbucket-bincompat-version-hyphens: 4-10
4+
:gitbucket-bincompat-version: 4.26.0
65

76
image:https://travis-ci.org/asciidoctor/gitbucket-asciidoctor-plugin.svg["Build Status", link="https://travis-ci.org/asciidoctor/gitbucket-asciidoctor-plugin"]
87
image:https://badges.gitter.im/asciidoctor/gitbucket-asciidoctor-plugin.svg["Gitter Chat", link="https://gitter.im/asciidoctor/gitbucket-asciidoctor-plugin"]
@@ -18,22 +17,37 @@ You can download a precompiled version from the https://github.com/asciidoctor/g
1817

1918
== Build from source
2019

20+
.With sbt
2121
----
22-
sbt clean package
22+
sbt assembly
2323
----
2424

25-
The built package is located at `target/scala-{scala-version}/gitbucket-{gitbucket-bincompat-version-hyphens}-asciidoctor-plugin_{scala-version}-{plugin-version}.jar`.
26-
25+
.Or with GNU Make
2726
----
28-
sbt assembly
27+
make build
2928
----
3029

31-
This makes the assembly package `target/scala-{scala-version}/gitbucket-{gitbucket-bincompat-version}-asciidoctor-plugin-assembly-{plugin-version}.jar` for deployment.
30+
You will find the packages plugin under `target/scala_2.12/gitbucket-asciidoctor-plugin-gitbucket_{gitbucket-bincompat-version}-{plugin-version}.jar`
3231

3332

3433
== Installation
3534

36-
Download `gitbucket-{gitbucket-bincompat-version}-asciidoctor-plugin-assembly-{plugin-version}.jar` or build the assembly package JAR file from source and copy it into `GITBUCKET_HOME/plugins`. If you have older versions of this plugin in this directory, you must delete them. Then restart GitBucket. That's it.
35+
Download `gitbucket-asciidoctor-plugin-gitbucket_{gitbucket-bincompat-version}-{plugin-version}.jar`
36+
or build the assembly package JAR file from source and copy it into `GITBUCKET_HOME/plugins`.
37+
If you have older versions of this plugin in this directory, you must delete them.
38+
Then restart GitBucket.
39+
That's it.
40+
41+
== Local Test Server
42+
43+
You can start a local GitBucket instance with this plugin already installed by running:
44+
45+
----
46+
make localServer
47+
----
48+
49+
Point your browser to http://localhost:8080. The administrator login is root/root.
50+
3751

3852
== Configuration
3953

0 commit comments

Comments
 (0)