WARNING: Developer documentation is currently under development

Chapter 0. Introduction

Welcome to the GRASP Framework technical documentation website. Here you will find all necessary information to start helping and participating in the project. There are many different ways to help in this project, from testing the code and reporting bugs to developing new features or correcting bugs, including also the mantenaince of the documentation (user and technical). We encourage the entire community to help out in the development of this software and we are at your disposal for any questions you may have. Do not hesitate to contact us.

Index of contents:

• 1. GRASP Contribution workflow
  • 1.1. Code and repository organization
  • 1.2. Open an issue
  • 1.3. Forking, contributing and pulling request
• 2. Contributions: How to and guides
  • 2.1. Bug reporting
  • 2.2. Documentation
    • 2.2.1. User documentation
    • 2.2.2. Technical documentation
  • 2.3. Developing
    • 2.3.1. Global libraries
      • 2.3.1.1. Output streams
    • 2.3.2. Extensions
      • 2.3.2.1. Input
        • 2.3.1.1.1. Drivers
        • 2.3.1.1.2. Transformers
      • 2.3.2.2. Output
        • 2.3.2.2.1. Segment functions
        • 2.3.2.2.2. Tile functions
        • 2.3.2.2.3. Current functions
    • 2.3.3. Making a new setting
• 3. Grasp-manager for developers

These pages are not intended for the casual user but for developers and maintainers. For simply installing and testing of the code, you may prefer to look at the GRASP user's documentation

Authors: Fabrice Ducos, David Fuertes, Tatsiana Lapionak