Note GitHub holding page in readme.md.
This commit is contained in:
parent
fb4542c39e
commit
7953d9c1f8
1 changed files with 1 additions and 37 deletions
38
README.md
38
README.md
|
|
@ -1,37 +1 @@
|
||||||
# Kraken C API
|
This is a holding page. For full details of the project please see https://rdmp.org/dmbcs/kraken-api. Thank you.
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue