#26 Ubuntu/Debian packages available.

[Anonymous]

Originally created by: cheako

I've uploaded cglm to a PPA located here:
https://launchpad.net/~cheako/+archive/ubuntu/cglm

There are several reasons why this source pkg would not be accepted into Debian:

1. The copyright file is still the default.
2. There is no documentation or manual pages, each exported function should be clearly defined.

[Anonymous]

Originally posted by: recp

@cheako thank you for this!

The copyright file is still the default.

I don't know what this means, it is unmodified MIT License, I added credits to LICENSE but I'm not sure it is the right place, I may move them to CREDITS file, I don't know what is best or right

There is no documentation or manual pages, each exported function should be clearly defined.

Actually each function is documented in its header, I only documented inline versions, should I do same for no-inline (call) versions too? I didn't want to duplicate same comments

Each exported function are defined in include/cglm/call header if you mean this

[Anonymous]

Originally posted by: cheako

There are several reasons why this source pkg would not be accepted into Debian:

The comments are related to the "source debian package". The debian/copyright file is a stub and not filled out and there is no documentation installed by the generated binary packages to /usr/share/doc.

It's a lot of work to properly document a sources licensing, it's nowhere near as easy as just saying "MIT License" and I loath doing this. I realy realy don't believe it should be the responsibility of the "technically inclined" person who can package applications.

It wouldn't be appropriate to drop the header files into /usr/share/doc and claim it's documentation, however a mirror of http://cglm.readthedocs.io would be perfect. I just hadn't done that yet.

Edit:
The website seems just a stub also, perhaps there would be interest to doxify the source.

[Anonymous]

Originally posted by: recp

FWIW, I have created a CREDITS file to keep LICENSE clear and unmodified.

cglm uses sphinx for docs. You can see docs at cglm/docs folder. http://cglm.readthedocs.io gets docs from this folder and builds it.

Docs (http://cglm.readthedocs.io/en/latest/) is still incomplete, I will update it in my free time.

Package manager could trigger sphinx build: http://www.sphinx-doc.org/en/stable/man/sphinx-build.html

[Anonymous]

Originally posted by: recp

@cheako I have just completed documentation, actually I borrowed API documentation from headers,
you can see the latest version at: http://cglm.readthedocs.io

readthedocs gets it from cglm/doc folder. After installed Sphinx (http://www.sphinx-doc.org/en/master/usage/installation.html) you can build docs like this:

$ cd cglm/docs
$ sphinx-build source build

it will compile .rst files in docs into .html file, you can grab them in docs/build folder after compiled it.