This is a template repository for starting new submodules

Table of contents

• 1. Introduction
• 2. How to use the submodules
  • 2.1. Directory structure
  • 2.2. Inserting the module to the PR testing framework
  • 2.3. Adding unittests
• 3. FAQ

Introduction

• Download (Either with the flag or in the txt file; optionally with HASH tag)
• Stored in optional/
• Locally also possible (without using e.g. github.com/gismo/gsModule.git)
• For having a github backup in github.com/gismo/ --> Contact gismo@inria.fr

How to use the submodules

As given in CMakeList.txt:

Directory structure

• Examples are stored in examples and can be run inside in build folder
• The same for filedata
• Source and Header files are in ...
• To include the header file, use eg. #include<src/gsHeader2.h>

Inserting the module to the CI/PR testing framework

• TODO

Adding unittests

• TODO

Frequently asked questions

• Dependency of other submodules (TODO)
• What happens when stable gets a PR and my module is not anymore working?
• ...