Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jonherrmann committed Oct 28, 2018
1 parent 24c5dde commit d95265f
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,19 @@ repo:list()

where GITHUB_TOKEN is your private GITHUB access token.

# Develop
## Developer quick start guide

Download [this](https://github.com/jonherrmann/etf-topox/blob/master/src/test/resources/ParseSegmentsTest.xq) XQuery file
as starting point.

- Create a Database with the test files. Note: the Database names must be suffixed with a three digits index, i.e. 'etf-topox-000' .
- Create a Database with the test files. Note: the Database names must be suffixed with a three digits index, edgeIndex.e. 'etf-topox-000' .

- the output will be generated to the _tmp_ directory, which can be changed in the topox:new-topology() call.

- The interface is described [here](https://github.com/jonherrmann/etf-topox/blob/master/src/main/xquery/TopoX.xq)
## Developer documentation

The developer documentation can be found [here](docs/Developer_documentation.md)

## Architecture documentation

The arc42 based architecture documentation can be found [here](docs/Architecture_documentation.md)

0 comments on commit d95265f

Please sign in to comment.