Skip to content

Commit

Permalink
chore: Refine document (#513)
Browse files Browse the repository at this point in the history
* fix document
  • Loading branch information
CsCherrYY authored May 31, 2021
1 parent 90cc9aa commit 713a0b9
Show file tree
Hide file tree
Showing 6 changed files with 41 additions and 9 deletions.
46 changes: 39 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,24 +2,56 @@

> Manage Java projects in Visual Studio Code
[![GitHub Actions](https://img.shields.io/github/workflow/status/microsoft/vscode-java-dependency/CI/master?style=flat-square)](https://github.com/microsoft/vscode-java-dependency/actions?query=workflow%3ACI+branch%3Amaster)
[![GitHub Actions](https://img.shields.io/github/workflow/status/microsoft/vscode-java-dependency/CI/main?style=flat-square)](https://github.com/microsoft/vscode-java-dependency/actions?query=workflow%3ACI+branch%3Amain)

## Overview

A lightweight extension to provide additional Java project explorer features. It works with [Language Support for Java by Red Hat](https://marketplace.visualstudio.com/items?itemName=redhat.java) to provide the following features:

* Project View
### Project View

![project-view](https://raw.githubusercontent.com/Microsoft/vscode-java-dependency/master/images/project-explorer.png)
![project-view](https://raw.githubusercontent.com/Microsoft/vscode-java-dependency/main/images/project-explorer.png)

* Create Java Projects
### Create Java Projects

![create project](https://raw.githubusercontent.com/Microsoft/vscode-java-dependency/master/images/create-project.png)
![create project](https://raw.githubusercontent.com/Microsoft/vscode-java-dependency/main/images/create-project.png)

* Export Jar
### Export Jar
> Note: For Spring Boot projects, please use the build tool to build the executable jar, for example: `mvn package`.
![export jar](https://raw.githubusercontent.com/Microsoft/vscode-java-dependency/master/images/export-jar.png)
![export jar](https://raw.githubusercontent.com/Microsoft/vscode-java-dependency/main/images/export-jar.png)

### Manage Dependencies

You can work with JAR files directly without any build tools. Go to `JAVA PROJECTS` view, find the `Referenced Libraries` node and click the `+` icon:

![Reference JAR Files](https://raw.githubusercontent.com/Microsoft/vscode-java-dependency/main/images/manage-dependencies.gif)

If you want to fine-tune this, go to `settings.json` and look for the `java.project.referencedLibraries` entry.

```json
"java.project.referencedLibraries": [
"library/**/*.jar",
"/home/username/lib/foo.jar"
]
```

You can tell that the glob pattern is supported. And here's more - you can include/exclude certain files, and attach source JARs:

```json
"java.project.referencedLibraries": {
"include": [
"library/**/*.jar",
"/home/username/lib/foo.jar"
],
"exclude": [
"library/sources/**"
],
"sources": {
"library/bar.jar": "library/sources/bar-src.jar"
}
}
```

## Requirements

Expand Down
Binary file modified images/create-project.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified images/export-jar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/manage-dependencies.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
"type": "git",
"url": "https://github.com/Microsoft/vscode-java-dependency.git"
},
"homepage": "https://github.com/Microsoft/vscode-java-dependency/blob/master/README.md",
"homepage": "https://github.com/Microsoft/vscode-java-dependency/blob/main/README.md",
"icon": "logo.png",
"capabilities": {
"virtualWorkspaces": false,
Expand Down
2 changes: 1 addition & 1 deletion templates/invisible-project/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ The workspace contains two folders by default, where:

## Dependency Management

The `JAVA DEPENDENCIES` view allows you to manage your dependencies. More details can be found [here](https://github.com/microsoft/vscode-java-pack/blob/master/release-notes/v0.9.0.md#work-with-jar-files-directly).
The `JAVA PROJECTS` view allows you to manage your dependencies. More details can be found [here](https://github.com/microsoft/vscode-java-dependency#manage-dependencies).

0 comments on commit 713a0b9

Please sign in to comment.