Skip to content

Lukc/danmaku-39

Repository files navigation

Documentation

Cette page recense tous les éléments quels qu'ils soient liés à la documentation du projet.

Liste des documentations possibles

  • API disponible pour la création de niveaux
  • Tutoriel sur la création d'un niveau (stage)
  • Installation du projet
    • pour développer
    • pour y jouer
  • Génération d'un exécutable du jeu (pour diffusion/publication)
  • Astuces diverses recueillies lors de la création du jeu (sorte de FAQ)
  • README.md sur le dépôt Github :
    • badges Github
    • présentation rapide
    • impression écran d'un élément du jeu
    • License
    • Comment contribuer
  • Tutoriel sur comment contribuer : charte pour coder ?

Tâches

  • planning des jours disponibles pour od
  • lister l'ensemble des documentations, outils et éléments permettant de faire de la documentation
  • quels outils pour faire une documentation propre, y compris tutoriel, avec schéma, etc. ?
    • lDoc pour API
    • gitbooks pour tutoriels ? Ou bien mkdocs pour générer doc sur Readthedocs automatiquement à chaque commit ?

Divers

  • dépendances : ldoc, love 0.10, luafilesystem, luarocks
  • badges pour README.md sur Github (utilise Lua 5.2, Löve 0.10, lDoc, etc.)
  • schémas des éléments disponibles et où ils apparaissent sur l'interface (impression écran d'un niveau + lignes qui partent des projectiles pour dire que c'est un Bullet, à la façon "schéma en biologie")

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published