init docs

7b72f956 · Sebastian Seufert · a0bea753 · 7b72f956 · 7b72f956 · 7b72f956
Commit 7b72f956 authored Nov 19, 2020 by Sebastian Seufert
Hide whitespace changes
Inline Side-by-side

Showing with 31 additions and 0 deletions

doc/readme.md doc/readme.md +9 -0

doc/requests.md doc/requests.md +1 -0

doc/schema.md doc/schema.md +1 -0

doc/startup-running.md doc/startup-running.md +20 -0

No files found.
--- a/doc/readme.md
+++ b/doc/readme.md
+### 
+
+- [Starting the server](startup-running.md)
+- [Requests](requests.md)
+- [Schema](schema.md)
+
+---
+
+- Version 0.1
\ No newline at end of file
--- a/doc/requests.md
+++ b/doc/requests.md
+[Index](readme)
\ No newline at end of file
--- a/doc/schema.md
+++ b/doc/schema.md
+[Index](readme)
\ No newline at end of file
--- a/doc/startup-running.md
+++ b/doc/startup-running.md
+[Index](readme)
+
+## Starting the API server
+
+### 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.
+
+#### Todos / Subject to Change ####
+
+- Options parsing from command line
+- daemon under *nix
+  
+
+
+
+