diff options
| author | Federico Tomassetti <federico@tomassetti.me> | 2018-02-12 16:34:03 +0100 |
|---|---|---|
| committer | Federico Tomassetti <federico@tomassetti.me> | 2018-02-12 16:34:03 +0100 |
| commit | 18d5a7d3109458991d852aeb5992ca125cdd6556 (patch) | |
| tree | b87920c2ff120e43755dec1bcc5d447152e0dab3 /readme.md | |
| parent | 8bc64c3e36027da80cd2f096f532638bf3ff7c5e (diff) | |
| download | javaparser-18d5a7d3109458991d852aeb5992ca125cdd6556.tar.gz | |
revise JavaParser readme to reflect JSS inclusion
Diffstat (limited to 'readme.md')
| -rw-r--r-- | readme.md | 30 |
1 files changed, 20 insertions, 10 deletions
@@ -1,17 +1,27 @@ -## Java Parser and Abstract Syntax Tree
-
-This package contains a Java 1.0 - Java 9 Parser with AST generation and visitor support.
-
-Our main site is at [JavaParser.org](http://javaparser.org)
+# JavaParser
[](http://search.maven.org/#search%7Cgav%7C1%7Cg%3A%22com.github.javaparser%22%20AND%20a%3A%22javaparser-core%22)
[](https://travis-ci.org/javaparser/javaparser)
[](https://coveralls.io/github/javaparser/javaparser?branch=master)
[](https://gitter.im/javaparser/javaparser?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
-## Dependency Management
+This project contains a set of libraries implementing a Java 1.0 - Java 9 Parser with AST generation and advanced features
+like:
+
+* comment attribution
+* lexical preservation
+* code generation
+* symbol resolution (through the JavaSymbolSolver module)
+
+Our main site is at [JavaParser.org](http://javaparser.org)
-The project binaries are available in Maven Central. Just add the following to your maven configuration or tailor to your own dependency management system.
+## Setup
+
+The project binaries are available in Maven Central.
+
+We strongly advises users to adopt Maven, Gradle or another build system for their projects.
+
+Just add the following to your maven configuration or tailor to your own dependency management system.
[Please refer to the Migration Guide when upgrading from 2.5.1 to 3.0.0+](https://github.com/javaparser/javaparser/wiki/Migration-Guide)
@@ -31,9 +41,9 @@ The project binaries are available in Maven Central. Just add the following to compile 'com.github.javaparser:javaparser-symbol-solver-core:3.5.14'
```
-
-
-Since Version 3.5.10, the JavaParser project includes the JavaSymbolSolver. While JavaParser generates an Abstract Syntax Tree, JavaSymbolSolver analyzes that AST and is able to find the relation between an element and its declaration (e.g. for a variable name it could be a parameter of a method, providing information about its type, position in the AST, ect).
+Since Version 3.5.10, the JavaParser project includes the JavaSymbolSolver.
+While JavaParser generates an Abstract Syntax Tree, JavaSymbolSolver analyzes that AST and is able to find
+the relation between an element and its declaration (e.g. for a variable name it could be a parameter of a method, providing information about its type, position in the AST, ect).
Using the dependency above will add both JavaParser and JavaSymbolSolver to your project. If you only need the core functionality of parsing Java source code in order to traverse and manipulate the generated AST, you can reduce your projects boilerplate by only including JavaParser to your project:
|