Skip to content
This repository was archived by the owner on Jul 10, 2024. It is now read-only.

Commit f71b9ec

Browse files
committed
updated readme
1 parent 0a18558 commit f71b9ec

File tree

1 file changed

+17
-7
lines changed

1 file changed

+17
-7
lines changed

README.md

+17-7
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,28 @@
11
LyChI (Layered Chemical Identifier)
22
===================================
33

4-
This directory contains code for BARD structure standardizer. To build
5-
simply type
4+
This directory contains code for BARD/GSRS structure standardizer and hash-code generator.
5+
6+
To build simply type:
7+
8+
```
9+
bash make.sh
10+
```
11+
12+
You will need to have maven installed. Inside the `make.sh` script it simply adds the dependencies and calls `mvn clean package`.
13+
14+
15+
This will build 2 jar files (one with dependencies and one without). They can be located in the `target` directory, and will look like:
616

717
```
8-
ant
18+
target/lychi-0.5.1.jar
19+
target/lychi-0.5.1-jar-with-dependencies.jar
920
```
1021

11-
To build a self-contained jar with dependencies included, use `ant
12-
all` instead. The self-contained jar file can be invoked directly;
13-
e.g.,
22+
The self-contained jar file can be invoked directly. For example:
1423

1524
```
16-
java -jar dist/lychi-all-v0.1.jar tests/standardizer_case1.smi
25+
java -jar target/lychi-0.5.1-jar-with-dependencies.jar tests/standardizer_case1.smi
1726
```
1827

28+

0 commit comments

Comments
 (0)