Skip to content

Commit 2a03889

Browse files
committed
docs: update readme file docs
Signed-off-by: Otavio Santana <[email protected]>
1 parent a55d230 commit 2a03889

File tree

1 file changed

+49
-25
lines changed

1 file changed

+49
-25
lines changed

README.adoc

Lines changed: 49 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,90 @@
1-
# arangodb-sample
1+
= arangodb-sample
22

33
This project uses Quarkus, the Supersonic Subatomic Java Framework.
44

5-
If you want to learn more about Quarkus, please visit its website: <https://quarkus.io/>.
5+
If you want to learn more about Quarkus, please visit its website: https://quarkus.io/.
66

7-
## Running the application in dev mode
7+
== Running the application in dev mode
88

99
You can run your application in dev mode that enables live coding using:
1010

11-
```shell script
11+
[source,shell]
12+
----
1213
./mvnw compile quarkus:dev
13-
```
14+
----
1415

15-
> **_NOTE:_** Quarkus now ships with a Dev UI, which is available in dev mode only at <http://localhost:8080/q/dev/>.
16+
[NOTE]
17+
====
18+
Quarkus now ships with a Dev UI, which is available in dev mode only at http://localhost:8080/q/dev/.
19+
====
1620

17-
## Packaging and running the application
21+
== Packaging and running the application
1822

1923
The application can be packaged using:
2024

21-
```shell script
25+
[source,shell]
26+
----
2227
./mvnw package
23-
```
28+
----
2429

2530
It produces the `quarkus-run.jar` file in the `target/quarkus-app/` directory.
2631
Be aware that it’s not an _über-jar_ as the dependencies are copied into the `target/quarkus-app/lib/` directory.
2732

28-
The application is now runnable using `java -jar target/quarkus-app/quarkus-run.jar`.
33+
The application is now runnable using:
34+
35+
[source,shell]
36+
----
37+
java -jar target/quarkus-app/quarkus-run.jar
38+
----
2939

3040
If you want to build an _über-jar_, execute the following command:
3141

32-
```shell script
42+
[source,shell]
43+
----
3344
./mvnw package -Dquarkus.package.jar.type=uber-jar
34-
```
45+
----
46+
47+
The application, packaged as an _über-jar_, is now runnable using:
3548

36-
The application, packaged as an _über-jar_, is now runnable using `java -jar target/*-runner.jar`.
49+
[source,shell]
50+
----
51+
java -jar target/*-runner.jar
52+
----
3753

38-
## Creating a native executable
54+
== Creating a native executable
3955

4056
You can create a native executable using:
4157

42-
```shell script
58+
[source,shell]
59+
----
4360
./mvnw package -Dnative
44-
```
61+
----
4562

4663
Or, if you don't have GraalVM installed, you can run the native executable build in a container using:
4764

48-
```shell script
65+
[source,shell]
66+
----
4967
./mvnw package -Dnative -Dquarkus.native.container-build=true
50-
```
68+
----
69+
70+
You can then execute your native executable with:
5171

52-
You can then execute your native executable with: `./target/arangodb-sample-1.0.0-SNAPSHOT-runner`
72+
[source,shell]
73+
----
74+
./target/arangodb-sample-1.0.0-SNAPSHOT-runner
75+
----
5376

54-
If you want to learn more about building native executables, please consult <https://quarkus.io/guides/maven-tooling>.
77+
If you want to learn more about building native executables, please consult https://quarkus.io/guides/maven-tooling.
5578

56-
## Related Guides
79+
== Related Guides
5780

58-
- REST ([guide](https://quarkus.io/guides/rest)): A Jakarta REST implementation utilizing build time processing and Vert.x. This extension is not compatible with the quarkus-resteasy extension, or any of the extensions that depend on it.
81+
* REST (https://quarkus.io/guides/rest): A Jakarta REST implementation utilizing build time processing and Vert.x.
82+
This extension is not compatible with the `quarkus-resteasy` extension, or any of the extensions that depend on it.
5983

60-
## Provided Code
84+
== Provided Code
6185

62-
### REST
86+
=== REST
6387

64-
Easily start your REST Web Services
88+
Easily start your REST Web Services.
6589

6690
[Related guide section...](https://quarkus.io/guides/getting-started-reactive#reactive-jax-rs-resources)

0 commit comments

Comments
 (0)