zeratax / yacx

Yet Another CudaExecutor - wrapper to easily compile and execute cuda kernels
https://zeratax.github.io/yacx
MIT License
8 stars 4 forks source link

[WIP] document usage better #163

Closed zeratax closed 4 years ago

zeratax commented 4 years ago

!fixes #74

c++ docs now go in docs/{html,latex} and java into docs/java

maybe instead it should be docs/{java,cpp}?

and should we create a tiny html thingie so when you go to https://github.com/ZerataX/yacx you get an overview over yacx and then you can pick if you want the cpp or the java docs?

kinda sad to remove my super cool makefiles, but really makes no sense to have makefiles and cmake

probably also need to figure out includes better to make importing this project easier like the current "yacx/Devices.hpp" works only with cmake I think? I guess that's fine, just never sure when I should use relative paths

LukasSiefke commented 4 years ago

Ich wäre für docs/{java,cpp} Das mit dem Html-Dings kann man machen, ist aber denke ich nicht soo wichtig Bei den includes bin ich mir auch immer unsicher. Beim JNI hatte ich dann immer den relativen Pfad mit ../../include/yacx/Klasse.cpp angegeben

zeratax commented 4 years ago

gonna do the import paths later, just want the readme to be somewhat clean for now