Skip to content
This repository has been archived by the owner on Nov 10, 2020. It is now read-only.

Expand Documentation #3

Open
veithm opened this issue Feb 21, 2013 · 2 comments
Open

Expand Documentation #3

veithm opened this issue Feb 21, 2013 · 2 comments

Comments

@veithm
Copy link
Member

veithm commented Feb 21, 2013

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
Copy link
Contributor

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 pushed a commit to markusbischof/capu that referenced this issue Mar 15, 2013
@markusbischof
Copy link
Contributor

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.

veithm pushed a commit that referenced this issue Mar 19, 2013
afrueh pushed a commit to afrueh/capu that referenced this issue Mar 19, 2013
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants