Skip to content

Updated Read Me #31

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Updated Read Me #31

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,13 @@ Execute ``make test`` to run all tests (currently there are only correctness tes

In the ``build`` directory you find the binary ``ted`` that executes the algorithms from command line. **Currently there is no help or documentation for this binary.**

## Generate the executable
In this example we will be using the gcc compiler (feel free to use others) :
```shell
cd src
g++ --std=c++17 -Inode -Ilabel -Icost_model -Iparser -Ited command_line/main.cc -o ted
```

## Installing the library with VCPKG

This library has been ported to [VCPKG](https://github.com/microsoft/vcpkg) package manager. To include in your project, install with ``./vcpkg install tree-similarity``, then include the library in your project's CMakeFile
Expand Down Expand Up @@ -64,7 +71,11 @@ Applications rarely use the bracket notation. Therefore, we have implemented var

### [JSON converter](https://frosch.cosy.sbg.ac.at/datasets/json/tools)

The `json-to-bracket.py` script converts an input JSON document into a bracket notation.
The [`json-to-bracket.py`](https://github.com/DatabaseGroup/jedi-datasets/blob/main/scripts/json2bracket.py) script converts an input JSON document into a bracket notation.
It can also be used :
```shell
python3 scripts/json2bracket.py -f /dir/to/input.json -s > /dir/to/input.bracket
```

### [Format converters](https://github.com/DatabaseGroup/format_converters)

Expand Down