diff --git a/README.md b/README.md index c2ae767..d590371 100644 --- a/README.md +++ b/README.md @@ -1,37 +1 @@ -# Kraken C API - -This API is intended for use on Linux/Unix-like systems. -The API depends on *Curl*. - -On the most distributions curl is installed by default, -if not, you can get it from here: - -https://curl.haxx.se/ - -## Infos - -Compile with *make*. - -Set/unset *DEBUG* or *TRACE* in the makefile to get trace/debug information -printed to stdout. - -## Usage - -Just include *kraken_api.h* in the sources of your own project. - -Get Doxygen and create the documentation. -If Doxygen is not installed you can get it from here: - -http://www.doxygen.org - -Once you have run *doxygen Doxyfile*, look in the documentation of *main.c*, -there you can find many examples. - -If you dont want to use doxygen, simply look into *main.c* -to see how to execute a trade. - -## ToDo's - -- rework trace/debug output -- documentation - +This is a holding page. For full details of the project please see https://rdmp.org/dmbcs/kraken-api. Thank you.