Open Source
There are some things to do before we can go open source.
In general we will do the same thing as walberla does. We will use the GPLv3 which is the one that walberla uses. We need a signed Contributer Agreement from everyone who wants to contribute. This is important if we want to relicense or if we ever would need to take legal action against someone who violated the license. Here we can also use the same one as walberla.
More technical tasks:
-
Rename namespaces (hhg -> hyteg) -
Rename repository (terraneo/tinyhhg -> ???/hyteg) -
Rename tinyhhg_core module and directories (-> hyteg) -
Create a License File (Copying.txt) (GPLv3) -
Create a Contributing.txt to explain our workflow for everyone (Contributer Agreement) -
Add notice of license into all files (including generated files!) -
Create automatic push to github for better visibility -
Add more information into the Readme to let people visiting the page know about the current state. -
Add at least one bigger tutorial/application as initial showcase -
Check what we need to do about FMT. Is it compatible with GPL?fmt ist not used anymore -
We should probably introduce some kind of versionwe think this is not necessary currently -
Check that all branches include the licensing comments (merge master into every branch or vice versa before open source) -
Fix make doc
to build the hyteg documentation and removemake doc_hyteg
target -
Fix image display error of published documentation -
Add meaningful main page to doxygen documentation -
Check current formatting and mention clang-format in README
Edited by Dominik Thoennes