search

bmwcarit / capu

Collections And Platform Utils (CAPU)
Apache License 2.0
19 stars 10 forks source link

Expand Documentation #3

Open veithm opened 11 years ago

veithm commented 11 years ago

At the moment the only documentation we have is our Readme.txt file.

We should expand the documentation, my proposal is to do it with doxygen in order to have both the API documentation and the rest of the documentation in on location. There is already a docs folder in the repository which contains a skeleton.

The documentation should contain at least a "How to build" section.

markusbischof commented 11 years ago

I just started a "How to build" documentation page.

When running the Documentation-Target, I get a lot of errors (which can be ignored).

"Problems running epstopdf. Check your TeX installation!"

I'm not sure where the errors come from, but I will continue to wirte the build-page.

markusbischof commented 11 years ago

I started a simple "how to build" page in my fork. I will extend it in the next one or two weeks and the start a pull request.