Commit e389ac23 authored by Siebers, Michael's avatar Siebers, Michael
Browse files

revised readme.md pointers to documentation

Closes #54
parent dff91a13
......@@ -35,7 +35,7 @@ Then start the server using SWI-Prolog, optionally with a custom port (default i
swipl run.pl --port 4444
```
After some informational messages you will see the interactive prolog interpreter. Then the server is running and accepting requests at localhost:PORT as given in the last informational message.
After some informational messages (starting with `%`) you will see the interactive prolog interpreter. Then the server is running and accepting requests at localhost:PORT as given in the last informational message.
```
% Loading explanation templates from file irrelevance_templates:
......@@ -67,16 +67,16 @@ After some informational messages you will see the interactive prolog interprete
You may freely use the Prolog interpreter while the server is running to stop the server enter `stop_server.`
## Documentation
[^local]: Links to localhost in section _Documentation_ assume that you started the server without explicit port option. If you started the server under another port, please replace `4444` accordingly.
Ongoing. Please check the [Wiki](https://gitlab.rz.uni-bamberg.de/cogsys/dare2del/demonstrator/-/wikis/home) in the meantime.
Details that might change:
The Dare2Del Demonstrator WebAPI component serves its own documentation. Unless turned of (see [Admin Guide](http://localhost:4444/doc/admin_guide.html)[^local]), the documentation may be accessed under [/doc](http://localhost:4444/doc)[^local]. Notably the following documents are available:
* Minor details in the JSON schemata
* HTTP status codes
* Error and Exception Handling
1. An [User Guide](http://localhost:4444/doc/user_guide.html)[^local]
1. A [detailed description of the API endpoints](http://localhost:4444/doc/api_endpoints.html)[^local]
1. An [Admin Guide](http://localhost:4444/doc/admin_guide.html)[^local]
1. A [file-by-file documentation of Prolog predicates](http://localhost:4444/doc/pldoc/doc/__API__/index.html)[^local]
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