Skip to content

Commit

Permalink
doc: Update spoon-javadoc installation instructions (#5632)
Browse files Browse the repository at this point in the history
  • Loading branch information
MartinWitt committed Jan 24, 2024
1 parent b3c9e03 commit 9068a15
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 7 deletions.
7 changes: 7 additions & 0 deletions doc/_data/sidebar_doc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,13 @@ entries:
product: all
version: all

- title: Javadoc Analysis
url: /spoon_javadoc.html
audience: writers, designers
platform: all
product: all
version: all

- title: FAQ
url: /faq.html
audience: writers, designers
Expand Down
14 changes: 7 additions & 7 deletions doc/spoon_javadoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@ converting them into your own format.

### Installation

On a Unix-like system, the following set of commands should be sufficient for
getting spoon-javadoc up and running from scratch.

```
$ git clone https://github.com/INRIA/spoon.git
$ cd spoon/spoon-pom
$ mvn install
To use spoon-javadoc, add the following dependency to your `pom.xml`:
```xml
<dependency>
<groupId>fr.inria.gforge.spoon</groupId>
<artifactId>spoon-javadoc</artifactId>
<version>$currentVersion</version>
</dependency>
```

### Basic usage
Expand Down

0 comments on commit 9068a15

Please sign in to comment.