Ivorforce / NumDot

Tensor math and scientific computation library for the Godot game engine.
https://numdot.readthedocs.io
MIT License
6 stars 3 forks source link

Provide a better workflow for custom builds #54

Closed Ivorforce closed 1 day ago

Ivorforce commented 5 days ago

The main way most users will download NumDot will be through the asset library (see #43).

However, some may want to build their own NumDot versions:

These options have to be implemented.

One way would to support this would be to add this repository as a submodule to the repo and let the user build it. However, since game projects involve both programmers and non-programmers, the game repo should probably still just host the pre-built binaries. Therefore, we should also write a short guide for how to fork the repository, make a build with the options, and add the needed binaries to the project. Somehow, they should not be hosted on GitHub, but just their versions, to avoid large files in the repo. I think this is what the asset library does.

Ivorforce commented 1 day ago

It's not very extensive, but we now do have a starting point for people who want to make custom builds: https://numdot.readthedocs.io/en/release-0.1/how-to-install/how-to-install.html#manual-build

It mostly builds off of Contributing.md, which is fine because that file contains all of the important information. Could probably be moved to the docs as well, but it's ok for now.