Commit 126f0bcd authored by Sebastian Seufert's avatar Sebastian Seufert
Browse files

Update readme.md

parent 2019d5ea
### ### Prerequisites ###
Check that SWI-Prolog has version `8.2.2` or higher.
### Starting
You can start the server using `run.pl`, starting a listener on port `4444` with a thread pool of 5 workers.
### Overview
The basic idea is to encapsulate the core logic into a web-based API that receives and responds JSON objects:
```mermaid
sequenceDiagram
participant Client
participant API
Client->>API: HTTP Request
API-->>Theory: Query
loop Rules & Learning
Theory-->>Theory: Irrelevancy / Explanation
end
Note right of Theory: Ipsum
Theory-->>API: Query Results
API->>Client: HTTP Response
```
### Documentation ###
Ongoing. Please check the [Wiki](https://gitlab.rz.uni-bamberg.de/cogsys/dare2del/demonstrator/-/wikis/home) in the meantime.
Details that might change:
* Minor details in the JSON schemata
* HTTP status codes
* Error and Exception Handling
- [Starting the server](doc/startup-running.md)
- [Requests](doc/requests.md)
- [Schema](doc/schema.md)
---
- Version 0.1
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment