Skip to content

Latest commit

 

History

History
130 lines (99 loc) · 4.49 KB

README.md

File metadata and controls

130 lines (99 loc) · 4.49 KB

S3_C_projet

Groupe 14 : Sagot Aelis, Vidal Mathéo, Raimbault Diane, Cutaia Evan, Godreuil Tim

Github repo: https://github.com/torsina/S3_C_projet

Program usage : ./main <opt : --verbose> See help : ./main --help

Exigences :

  • Coder en anglais

  • Noms de fichiers en minuscules, séparés par des tirets "-"

  • Extensions .c, .h, .inc

  • Noms de type en CamelCase sans tirets. Pour les struct/enum/union, utiliser un underscore devant "_" Ex : typedef struct _Polygon Polygon;

  • Macros/constantes en majuscules avec un underscore "_" entre chaque mot

  • Variables en minuscules avec un underscore "_" entre chaque mot

  • Dans chaque header, utiliser un include guard au format : <nom du projet>_<chemin>_<nom header>_H_

  • Dans les .c : inclure le .h (même nom que .c), saut de ligne, inclure librairie standard, saut de ligne, inclure librairie externes, saut de ligne, inclure headers du projet, saut de ligne, inclure .inc

  • Utiliser le style de Google, formatter avec clang-format et vérifier avec cclint

  • Protéger les champs (avec .inc) et faire des getters/setters

  • Générer la documentation avec sphinx en respectant la norme doxygen

  • Tests unitaires + valgrind + cclint. Dans un dossier "test"

OUTILS UTILISÉS :

  • CLion avec mingw32 (gcc, g++, make)
  • CMake

CONFIGURER CLANG-FORMAT EN LOCAL SUR CLION :

Aller dans Settings > Editor > Code Style.

  • Changer Scheme de "Default" à "Project"

  • Cliquer sur "Enable ClangFormat with clangd server"

  • On peut faire CTRL+ALT+L ou Code > Reformat pour reformatter

  • Avoir le .clang-format bien dans la racine

  • Ne pas le modifier. Si besoin, taper un caractère et l'enlever puis sauvegarder pour forcer CLion à le recharger.

  • TOUT EN BAS DE L'ECRAN (à côté de UTF-8) il doit y avoir : ClangFormat

CONFIGURER CCLINT :

  • Avoir python 3 installé
  • pip install cclint ou pip3 install cclint

MINGW :

  • Version 32 bits
  • Modules :
Nom
mingw32-gcc-bin
mingw32-gcc-g++-bin
mingw32-gdb-bin
mingw32-make-bin
  • Ajouter C:\MinGW\bin au PATH (chercher "variables d'environnement" sur Windows, cliquer sur "variables d'environnement" puis modifier "path" et ajouter la ligne).
  • Pour faire un make : aller (avec cd) dans /cmake-build-debug puis mingw32-make.

PYTHON

  • Settings > Build, Execution, Deployment > Python Interpreter et configurer l'interpréteur Python.

SPHINX

DOXYGEN

  • Télécharger Doxygen (installateur Windows).
  • Doxygen doit être ajouté au PATH. Tester dans un dossier vide d'utiliser la commande doxygen dans l'interpréteur de commande.

BREATHE

  • Utiliser la commande pip install -U breathe.

Exemple :

/**
 *  \brief Cette fonction calcule
 *         la racine carrée.
 *  \author Francis
 *  \version 1.2.0
 *  \date 12 octobre 2019
 *  \fn double sqrt(double val)
 *  \param val Valeur dont on souhaite
 *             trouver la racine carrée.
 *  \return La racine carrée de val.
 */
double sqrt(double val) {
    ...
}

GÉNÉRATION DE LA DOCUMENTATION

  • Utiliser la commande mingw32-make docs

INSTALLATION DE LIBYAML

Sous windows

  1. Allez sur le github de libYAML et téléchargez le zip du master
  2. Ouvrez dans un IDE (Visual Studio, CLion)
  3. A la ligne 56 du CMakeLists.txt, changez : add_library(yaml ${SRCS}) en add_library(yaml SHARED ${SRCS})
  4. Exécutez CMake avec le CMakeLists.txt.
  5. Faites un make all (ou CMake > Générer uniquement > Tout (yaml) sur VS).
  6. Faites un make install (ou CMake > Installer > yaml).
  7. Sur Windows, ajouter le dossier d'installation de la DLL (C:/Program Files (x86)/yaml/bin/) au PATH.

Sous linux

  1. git clone https://github.com/yaml/libyaml.git
  2. ./bootstrap
  3. ./configure
  4. cmake . (éventuellement -DCMAKE_INSTALL_PREFIX=$HOME/.local)
  5. make
  6. sudo make install
  7. Vérifier si les fichiers sont bien installés (et peut être ajouter le répertoire d'installation au PATH).