-
Notifications
You must be signed in to change notification settings - Fork 80
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
new readme #11
new readme #11
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you provide:
- a short description,
- requirements (Java ...)
- a list of supported features
README.md
Outdated
|
||
## Get VSIX Extension | ||
|
||
* [Click here](http://download.jboss.org/jbosstools/vscode-xml/staging/) for the latests development VSIX |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
latest development VSIX archives
README.md
Outdated
|
||
## Get VSIX Extension | ||
|
||
* [Click here](http://download.jboss.org/jbosstools/vscode-xml/staging/) for the latests development VSIX |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@fbricon updated |
README.md
Outdated
|
||
This VSCode extension provides support during the creation of XML documents | ||
|
||
## Features |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
those are LSP features. Users don't care about those. You need to translate to plain English
README.md
Outdated
@@ -1,9 +1,30 @@ | |||
# VSCode XML Client | |||
|
|||
## Description | |||
|
|||
This VSCode extension provides support during the creation of XML documents |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
creation and edition.
Finish sentence with a period.
README.md
Outdated
|
||
## Requirements | ||
|
||
Java 8/9 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we (you) definitely need to fix Java 10 support (See #1)
README.md
Outdated
|
||
## Get VSIX Extension | ||
|
||
* [Click here](http://download.jboss.org/jbosstools/vscode-xml/staging/?C=M;O=D) for the latests development VSIX | ||
* [Click here](http://download.jboss.org/jbosstools/vscode-xml/staging/?C=M;O=D) latest development VSIX archives |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
for the latest
README.md
Outdated
|
||
## License | ||
|
||
EPL 1.0, See LICENSE file. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
there is no LICENSE file, you need to add it
README.md
Outdated
|
||
This VSCode extension provides creation and edition during the creation of XML documents. | ||
|
||
## Get VSIX Extension |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
merge with installation paragraph
README.md
Outdated
* `java.home` in VSCode preferences | ||
* Environment variable `JAVA_HOME` or `JDK_HOME` | ||
|
||
## How to Install |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Installation
README.md
Outdated
* Document Folding | ||
* Symbols and Renaming | ||
* Error Validation | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
And Hover (based on XML Schema) & Format
README.md
Outdated
* Code completion | ||
* Document Folding | ||
* Symbols and Renaming | ||
* Error Validation |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Syntax Error and XML Schema Validation
README.md
Outdated
## Features | ||
|
||
* Start and End Tag highlighting | ||
* Code completion |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code completion based on XML Schema Validation
@fbricon updated with angelo's suggestions, and consideration for all java versions |
@@ -79,9 +79,17 @@ function readJavaConfig() : string { | |||
function checkJavaVersion(java_home: string): Promise<number> { | |||
return new Promise((resolve, reject) => { | |||
cp.execFile(java_home + '/bin/java', ['-version'], {}, (error, stdout, stderr) => { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll allow the quick n'dirty fix for now, but you should make it more robust eventually, see #1
README.md
Outdated
|
||
## Description | ||
|
||
This VSCode extension provides creation and edition during the creation of XML documents. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
creation x 2
README.md
Outdated
|
||
## License | ||
|
||
EPL 1.0, See [LICENSE](https://github.com/NikolasKomonen/vscode-xml/blob/readme/LICENSE) file. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
[LICENSE](https://github.com/redhat-developer/vscode-xml/blob/readme/LICENSE)
Signed-off-by: Nikolas Komonen <nikolaskomonen@gmail.com>
No description provided.