From 80bf6f6451e78dc7bfd1a1477d651da5898958a5 Mon Sep 17 00:00:00 2001 From: Martin Wittlinger Date: Tue, 23 Jan 2024 16:57:03 +0100 Subject: [PATCH] fix: Update spoon-javadoc installation instructions The previous spoon-javadoc installation steps were replaced with instructions for Maven dependency. Moreover, a new section "Javadoc Analysis" was also added to the sidebar in the documentation. These changes make it easier for users to incorporate spoon-javadoc into their projects. --- doc/_data/sidebar_doc.yml | 7 +++++++ doc/spoon_javadoc.md | 14 +++++++------- 2 files changed, 14 insertions(+), 7 deletions(-) diff --git a/doc/_data/sidebar_doc.yml b/doc/_data/sidebar_doc.yml index c8eba2008b8..6a6ddb31276 100644 --- a/doc/_data/sidebar_doc.yml +++ b/doc/_data/sidebar_doc.yml @@ -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 diff --git a/doc/spoon_javadoc.md b/doc/spoon_javadoc.md index 5f8fcc0163e..44d6254d50f 100644 --- a/doc/spoon_javadoc.md +++ b/doc/spoon_javadoc.md @@ -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 + + fr.inria.gforge.spoon + spoon-javadoc + $currentVersion + ``` ### Basic usage