Skip to content

Create a specification book with issue on GitHub and Git Lab

License

Notifications You must be signed in to change notification settings

leroycharles/specs-maker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

1 Commit
 
 
 
 
 
 

Repository files navigation

SPECS MAKER

Overview

Specs Maker allows a developper to generate a specification book form the issues of a project hosted on GitHub or Gitlab. Allows a GitLab/GitHub User to create a specification book from the issues of the repo and some selected files in it.

The Way (it should) Works

  1. The page use a form to determine what repository, what authentification etc
  2. The script collect all the informations required
  3. The script transforms the raw data into coherent objects
  4. The page display the specification in Markdown and in LaTeX

Additionnal Features

  • Automated Documentation with Doxygen and GitHub Pages
  • The script can be used in GitLab CI/CD
  • The script can be used in GitHub CI/CD
  • The script can be configured with a config file
  • The script can be used to create an automatic presentation
  • The config file can be generated with a dedicated page

Tools Used

.gitignore

IDE

Documentation

About

Create a specification book with issue on GitHub and Git Lab

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published