From 6e24a06d199548ffd52a599f140a108030803fb0 Mon Sep 17 00:00:00 2001 From: Rome Li Date: Tue, 26 Sep 2017 16:25:40 +0800 Subject: [PATCH] Edit readme.md and changelog.md --- CHANGELOG.md | 17 +++++++++++++++-- README.md | 33 +++++++++++++++++++++++++-------- 2 files changed, 40 insertions(+), 10 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 43bafa5c..92180c72 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,20 @@ # Change Log All notable changes to the "vscode-java-debugger" extension will be documented in this file. -Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how to structure this file. +The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) +and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). ## [Unreleased] -- Initial release \ No newline at end of file + +## 0.1.0 - 2017-09-27 +### Added + +- Launch/Attach +- Breakpoints +- Exceptions +- Pause & Continue +- Step In/Out/Over +- Variables +- Callstacks +- Threads +- Debug console \ No newline at end of file diff --git a/README.md b/README.md index 4ff7a698..5a852fbc 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,7 @@ [![Gitter](https://badges.gitter.im/Microsoft/vscode-java-debug.svg)](https://gitter.im/Microsoft/vscode-java-debug) ## Overview -A lightweight Java Debugger based on [Java Debug Server](https://github.com/Microsoft/java-debug). It works with [Language Support for Java by Red Hat](https://marketplace.visualstudio.com/items?itemName=redhat.java) to allow users debugging Java code using Visual Studio Code (VS Code). - -## Features +A lightweight Java Debugger based on [Java Debug Server](https://github.com/Microsoft/java-debug). It works with [Language Support for Java by Red Hat](https://marketplace.visualstudio.com/items?itemName=redhat.java) to allow users debugging Java code using Visual Studio Code (VS Code). Here's a list of features: - Launch/Attach - Breakpoints @@ -17,14 +15,33 @@ A lightweight Java Debugger based on [Java Debug Server](https://github.com/Micr - Threads - Debug console -## Usage +## Install + +Open VS Code and press `F1` or `Ctrl + Shift + P` to open command palette, select **Install Extension** and type `vscode-java-debug`. + +Or launch VS Code Quick Open (`Ctrl + P`), paste the following command, and press enter. +```bash +ext install vscode-java-debug +``` + +## Use - Launch VS Code - Open a Java project (Maven/Gradle/Eclipse) -- Open a Java file to activate the related extensions -- Add debug configuration and specify "mainClass" in launch.json +- Open a Java file to activate the extensions +- Add debug configurations and edit launch.json + - To launch: specify `mainClass` + - To attach: specify `hostName` and `port` - Press F5 -## Feedbacks +Please also check the documentation of [Language Support for Java by Red Hat](https://marketplace.visualstudio.com/items?itemName=redhat.java) if you have trouble setting up your project. + +## Options -Please share your feedbacks and ask questions to help us improve. See you [here](https://gitter.im/Microsoft/vscode-java-debug). \ No newline at end of file +- `java.debug.logLevel`: minimum level of debugger logs that are sent to VS Code, defaults to `warn`. + +## Feedback and Questions + +Please share your feedback and ask questions to help us improve. + +[![Gitter](https://badges.gitter.im/Microsoft/vscode-java-debug.svg)](https://gitter.im/Microsoft/vscode-java-debug)