Browse Source

Language Overview in Readme (#584)

* provide an overview of supported languages and their versions in the readme
* add information regarding the state of the language modules
* add information regarding the parser used for the language

Co-authored-by: Timur Sağlam <timur.saglam@kit.edu>
Jan Wittler 4 years ago
parent
commit
f8df6d8e92
1 changed files with 20 additions and 1 deletions
  1. 20 1
      README.md

+ 20 - 1
README.md

@@ -9,7 +9,26 @@
 [![License](https://img.shields.io/github/license/jplag/jplag.svg)](https://github.com/jplag/jplag/blob/master/LICENSE)
 [![License](https://img.shields.io/github/license/jplag/jplag.svg)](https://github.com/jplag/jplag/blob/master/LICENSE)
 [![Lines of code](https://img.shields.io/tokei/lines/github/jplag/jplag)](https://github.com/jplag/jplag/graphs/contributors)
 [![Lines of code](https://img.shields.io/tokei/lines/github/jplag/jplag)](https://github.com/jplag/jplag/graphs/contributors)
 
 
-JPlag is a system that finds similarities among multiple sets of source code files. This way it can detect software plagiarism and collusion in software development. JPlag currently supports Java, C#, C, C++, Python 3, Scheme, and natural language text.
+JPlag is a system that finds similarities among multiple sets of source code files. This way it can detect software plagiarism and collusion in software development. JPlag currently supports various programming languages, EMF metamodels, and natural language text.
+
+## Supported Languages
+
+In the following, a list of all supported languages with their supported language version is provided. A language can be selected from the command line using the `-l <cli argument name>` argument.
+
+| Language | Version | CLI Argument Name | [state](https://github.com/jplag/JPlag/wiki/3.-Language-Modules) | parser
+| --- | ---: | --- | :---: | :---: |
+| [Java](https://www.java.com) | 17 | java | mature | JavaC |
+| [C++](https://isocpp.org) | 11 | cpp | legacy | JavaCC |
+| [C#](https://docs.microsoft.com/en-us/dotnet/csharp/) | 8 | csharp | beta | ANTLR 4 |
+| [Go](https://go.dev) | 1.17 | golang | beta | ANTLR 4 |
+| [Kotlin](https://kotlinlang.org) | 1.3 | kotlin | beta | ANTLR 4 |
+| [Python](https://www.python.org) | 3.6 | python3 | legacy | ANTLR 4 |
+| [R](https://www.r-project.org/) | 3.5.0 | rlang | beta | ANTLR 4 |
+| [Scala](https://www.scala-lang.org) | 2.13.8 | scala | beta | Scalameta |
+| [Scheme](http://www.scheme-reports.org) | ? | scheme | unknown | JavaCC |
+| [EMF Metamodel](https://www.eclipse.org/modeling/emf/) | 2.25.0 | emf-metamodel | alpha | EMF |
+| [EMF Metamodel](https://www.eclipse.org/modeling/emf/) (dynamic) | 2.25.0 | emf-metamodel-dynamic | alpha | EMF |
+| Text (naive) | - | text | legacy | ANTLR |
 
 
 ## Download and Installation
 ## Download and Installation