---
# System prepended metadata

title: HACKMD ORC-EPITA
tags: [OCR-EPITA]

---

---
title: "HACKMD ORC-EPITA"
date: "13-09-2024"
link: "https://hackmd.io/lSOEJFhUT9GBf7XfMQT7nQ?both"
tags: OCR-EPITA
---

# OCR PROJECT EPITA - DOCUMENTATION

## Documentations

### Nos sources
* [Debug] TODO
* [Image](https://hackmd.io/@GBaechler/r1Mmhmn6R/edit)
* [IA](https://hackmd.io/@TxbKjcpNT-6ci1Mj2cDAbw/B17dkz6x1l/edit)
* [Math](https://hackmd.io/@PcK4JjiHQVGKRWZJkN4y1Q/Syozdqvk1g/edit)
* [MakeFile](https://hackmd.io/@TxbKjcpNT-6ci1Mj2cDAbw/H1oOh9DJJe/edit)
* [Solveur](https://hackmd.io/aquPtMjGRyyirs7Mu9qwtQ)
* [UI](https://hackmd.io/@GBaechler/r1eBgzR7yg/edit)

### Librairies

* [SDL2](https://wiki.libsdl.org/SDL2/FrontPage)
* [Criterion](https://criterion.readthedocs.io/_/downloads/en/stable/pdf/)

## Style
```c

#define MAGIC_VALUE 255

// void -> int
// <explication>
int* my_fun(int *v);
// classé par type
void my_fun2();

struct my_struct
{
    int attribut;
}

int* my_fun(int *arg)
{
    
    if (<condition>)
    {
        //this is a comment
        int *pointer;
        int var1 = 1;
        int my_var = var1;
        int w[] = { MAGIC_VALUE, MAGIC_VALUE, MAGIC_VALUE };
        int *v1 = malloc(sizeof(int) * var1);
    }
    else if(<condition>)
        ERROR("def of the error");
    
    // commentaire
    else
    {
        for(size_t i = 0; i < feur; i++)
        {
            printf("H");    
        }
    }
    
    return NULL;
}
```




## Template de documentation:

### Fonction main:
```c
int main(int argc, char** argv);
```

#### Arguments:
* argc: nombre d'arguments envoyés dans la fonction (min: 1)
* argv: arguments de la fonction sous forme de liste string (le premier est le nom du programme)
#### Valeur de retour: 
* valeur de sortie du programme
#### Description:
* Cette fonction est le point d'entré du programme.
