tmxlite

tmxlite copied to clipboard

Would it be possible to add the documentation with it? Maybe some markdown files? maybe with the help of this tool: doxygen xml to markdown?

Sure, this sounds like a good idea. Will endeavour to add it (although can't say when though)

Well I can just run the latest doxygen documentaion run the tool fork and then pullrequest ^^ and all you have to do is merge ^^

If you want to do that, that would be great, thanks! Ideally I'd like to automate it as part of the build process with cmake or something, but this will be a good start.

If I have time I will do it this week. Maybe I can have a look into that. For windows there could be a bat file or something.

Question: Do you want to keep the doxygen file, so that the end user can create his / her documentation themself or do you want to add the doxygen file as well as as the mentioned markdown documentation in a folder tmxlite/doc ?

I was thinking of adding adding a bat file which creates automatically the documentation with doxygen if installed. As requested before it would be nice to have documentation here on GitHub to which was why I would suggest markdown files in a doc folder.

There's no harm in renaming the documentation directory to 'doc' I guess, if it's more in line with convention. I'd prefer to keep the doxy file to make creating the docs as flexible as possible - remember this has to be cross platform. A bat file will only work on windows and would require also maintaining a shell script or similar for mac and linux platforms. The best approach would probably be via cmake doxygen support, so that a user can decide if documentation is built at the same time as the library. If you have some markdown pages already created you can always add them to the wiki.

In terms of the convention I guess documentation is fine. Yes this all make sense. I have translated the doxygen generated files to markdown with the help of moxygen. The cmake idea is better then my suggestion, because of the fact that cmake is cross platform.

In regards of cmake would it than not be good to download all the dependencies via cmake when the "solution" gets created, instead of including pugi::xml in details?

Usually I would pull down dependencies in this manner - but in this case the files are small enough to be contained within the repo, and the risk of breaking changes from newer versions of pugi are minimised. After all, the idea of tmxlite was to create a library quickly and easily without dependency hunting :) As I said, please feel free to add any markdown to the wiki pages, which would probably be the easiest place for people to look for ready-made documentation (and don't forget to put your name in the credits!). Thanks!

Sure sure! I will help how I can. tmxlite is an amazing lib and very useful for my uni project