Configuration File

Configuration file

The mdCreator configuration file can be a little bit hard to understand. mdCreator is provided with a given configuration that explains you what to do.

Here is the basic configuration file given for this project:

{
  "student": {
    "header": {
        "range": 1,
        "title": null,
        "description": " is a new project."
    },
    "disclaimer": {
        "range": 2,
        "title": "Before continuing...",
        "description": "This project is an EPITECH Project. If you are an EPITECH student, move out the way! Nothing to see here... The groups don't want to be involved to your -42.<br/>If you're not, no worries! You're welcome here!"
    },
    "prerequisites": {
        "range": 3,
        "title": "Prerequisites"
    },
    "program": {
        "range": 3,
        "title": "Building program",
        "description": "Tell here how to compile / use / test your program."
    },
    "style": {
        "range": 3,
        "title": "Coding Style"
    },
    "authors": {
        "range": 2,
        "title": "Authors",
        "description": "* **Arthur Adam** - [0Nom4D](https://github.com/0Nom4D)"
    },
    "gifs": {
      "nbGifs": 5
    }
  },
  "pro": {
    "header": {
        "range": 1,
        "title": null,
        "description": " is a new project."
    },
    "gifs": {
      "nbGifs": 5
    }
  }
}

You can also change this configuration file to use mdCreator as you wish.

Before changing the configuration file here are some explanations about this configuration file.

Since issue #7, configuration file has been changed and you now have access to a student configuration and to a professional configuration.

You can modify your pro configuration at will. And it will changed for every new README you're creating.

Explanations under this are about the student configuration, but explanations are valid for every other configurations.

Common parts

The configuration file sections must contain a range, a title and a description.

Range

Range is the size of the section title. You can have a lot of differents sizes from 1 to x, corresponding to h1 - ... - hx.

Title

Title is the title given to your section. This section's title will be written accordingly to the range given to the configuration file.

Description

Section's description is the description given to your section. This allows you to give a little context to your section.

Specials Sections

Header

Header section is an essential section to introduce your project to, I'm gonna say, anybody.

As you can see in the basic configuration file, we have:

"header": {
    "range": 1,
    "title": null,
    "description": " is a new project."
}

Header is the only configuration file object that must have its title set as null in the configuration file.

By setting the header section title to null, the title will be changed by the arguments given to the -p/--pname option. For example:

$> ./mdCreator -p NewProject -l C++

README.md created.
Don't forget to edit your README.md file if something's wrong with the existing file.
If any error occurs, please create an issue or contact Nom4D- | NMS#0811 on Discord.

$> head -n 3 README.md
# NewProject

NewProject is a new project.

Style and Prerequesites

Style

Style section is dedicated to Coding Style. This section is used by EPITECH Students using the different norms used by the school.

Style doesn't need any description. The description is automaticly adapted to the language passed as parameter. If your project use any language that doesn't use EPITECH Norm, mdCreator will provide a message saying this:

EPITECH doesn't impose any Coding Style to this but I tried to be as cleaner as possible.

Prerequisites

Prerequisites section doesn't need description. This section is written according to the language you pass as parameter.

By now, mdCreator only set prerequisites for C / C++ / Haskell and Python languages.

Therefore you can change the README file if any of the information given by the program doesn't corresponds to what you're looking for.

Gifs

Gifs section is dedicated to the number of gifs you get while using the API. You can ask for any gifs you want.

Value can't be negative or null. Gifs section doesn't need any range or any title / description either. If they're set, theses variables aren't used by mdCreator.