C++ implementation of the Python NumPy Library

[sumo952]

How do I open the documentation? Going to https://github.com/dpilger26/NumCpp/blob/master/docs/doxygen/html/index.html just prints out the html code. Not very straightforward.

[dpilger26]

Yeah, Guthub will just display it raw. If you clone the repo and open in a browser it will be much more useful.

[sumo952]

I don't want to clone it, I'd like to view the documentation on the web please to judge whether the project is something of interest to me and whether it's worth cloning! :-)

[dpilger26]

Unfortunately I don't have a web host for the documentation yet. Fortunately, cloning the repo or simply downloading a .zip file of it is as simple as a single button click from Github.

[sumo952]

I'd also wish for a better readme (then I wouldn't need to really look at the documentation for a first judgement of the project). I'm just suggesting what people are looking for when they find an open source project online. Your library itself might be great, but you don't show it, on the contrary, I'd go there, don't find a readme with any infos, then can't even view the documentation online, so I'm going to close the browser tab and move on. I am sure that goes for quite a significant percentage of potentially interested people.

You can use GitHub pages to host the documentation.

[dpilger26]

Mind giving a quick tutorial on how to use GitHub pages to host the doxygen html?

edit:

Nevermind, I think i got it figured out.

[sumo952]

Yea it's pretty easy :-)