Skip to content

Commit d89886d

Browse files
committed
Updated LBJava documentation
Removed pointer to installation Replaced all references to `LBJ2` and "LBJ" Added pointer to maven-plugin for compile `.lbj` files
1 parent f8a15ed commit d89886d

4 files changed

Lines changed: 188 additions & 349 deletions

File tree

lbjava/README.md

Lines changed: 31 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,8 @@ Visit each link for its content
1414
3. [A working example: classifiying newsgroup documents into topics](doc/20NEWSGROUP.md)
1515
4. [Syntax of LBJava](doc/LBJLANGUAGE.md)
1616
5. [LBJava library](doc/LBJLIBRARY.md)
17-
6. [Installation and Commandline options](doc/INSTALLATION.md)
18-
7. [A working example: regression](doc/REGRESSION.md)
19-
8. [Learning Algorithms](doc/ALGORITHMS.md)
17+
6. [A working example: regression](doc/REGRESSION.md)
18+
7. [Learning Algorithms](doc/ALGORITHMS.md)
2019

2120
## Using it as a dependency
2221
To include LBJava in your Maven project, add the following snippet with the
@@ -44,7 +43,35 @@ To include LBJava in your Maven project, add the following snippet with the
4443
</repositories>
4544
```
4645

47-
## Compiling the code
46+
## Compiling LBJava code in your projects
47+
To compile the `.lbj` files into Java code you will need to use the [LBJava maven plugin](../lbjava-mvn-plugin/README.md).
48+
Briefly, you need to add the `<pluginRepositories>` and `<build>` snippets into your pom.xml file:
49+
```xml
50+
<pluginRepositories>
51+
<pluginRepository>
52+
<id>CogcompSoftware</id>
53+
<name>CogcompSoftware</name>
54+
<url>http://cogcomp.cs.illinois.edu/m2repo/</url>
55+
</pluginRepository>
56+
</pluginRepositories>
57+
...
58+
<build>
59+
<plugins>
60+
<plugin>
61+
<groupId>edu.illinois.cs.cogcomp</groupId>
62+
<artifactId>lbjava-maven-plugin</artifactId>
63+
<version>LBJAVA-VERSION</version>
64+
<configuration>
65+
<lbjavaInputFileList>
66+
<param>lbjava/MyClassifier.lbj</param>
67+
</lbjavaInputFileList>
68+
</configuration>
69+
</plugin>
70+
</plugins>
71+
</build>
72+
```
73+
74+
## Compiling the LBJava-core code
4875
To compile and package the LBJava code simply run:
4976

5077
mvn install

lbjava/doc/INSTALLATION.md

Lines changed: 0 additions & 188 deletions
This file was deleted.

0 commit comments

Comments
 (0)