0nom4d / mdcreator

mdCreator creates a README.md file from command line and with a .json configuration file.

	Hey... You miss me? Well, technically, you did, didn't you?

"Who is 0Nom4D?"

• 🇫🇷 French
• 🔬 Former medical student at UFR Santé Nantes
• 📚 5th year student in Programming and Computer Science
• 🔴⚪ Great supporter of the Stade de Reims
• 🔱 Huge fan of Destiny 2, Baldur's Gate 3 and Helldivers 2

Wanna see my medals?

For the past 2 years, I've been focusing on working on web and mobile project.

• 📱 Aeris, an action-reaction manager, developed in Flutter (Mobile), ReactTS (Web) and Haskell (Backend)
• 🌕 GuardianDock, a Destiny 2 mobile stat tracker, developed in Flutter
• 🧸 ToysRevive, a toy giving mobile platform, developed with Jetpack Compose
• 🟥⬜ PSV Fan Experience, a fan engaging platform developed in partnership with PSV Eindhoven Football Club, developed with Flutter

I also made some other projets that are not mobile development:

• 💽 T6 Modding Workshop, a quick workshop to discover GSC modding for Call Of Duty: Black Ops 2
• ⚔️ my_RPG, a RPG game, made in C with C SFML bindings
• ➕ You can find some others projects on this repository or directly on my profile.

Some technologies I'm enjoying working on

Some stats

mdcreator's Issues

Gif ApiLoader loads request from language argument

A bug appears when no gif keywords are given as arguments. It will search gifs with the languages name.

To Reproduce
Steps to reproduce the behavior:

1. Launch mdCreator as it follows:

$> mdCreator -p $(project_name) -l $(language)

Expected behavior
Without any gif keywords, no gifs should be added inside the REAMDE.md file.

Auto-Updater for mdCreator

Auto-Updater for mdCreator

Why this feature?

By using the mdCreator, you would ask for cooler and cooler features.

For now on, mdCreator Team (that means me but that seems cool to write this) will develop an auto-updater file.

Feature Description

Such as OhMyZsh, when you'll launch the mdCreator, the mdCreator will:

• Check for an update
• Ask you if you want to install the newest version
• Launch the program with the latest version

This will allow you to always be connected to the project even without thinking about it.

When will this be available?

This feature will be available on an unknown date. Keep checking this issue for more informations.

Adding a Changelog

Adding a Changelog

Why this feature?

This feature will be included because of the creation of a roadmap for the mdCreator.

Feature Description

That's just a CHANGELOG.md file adding. Keep calm...

Nothing incredible here.

##When will it be up?

This feature will be added to repository in the next update.

File configuration for non-student users

Why this feature?

This feature is designed for non-student users. The goal is to have the best configuration experience for mdCreator.

Feature Description

When launching the program after the update, the program will ask you if you're a student or not.

If you are a student, the program will write the result as it writes now.

If you're not, the program will write the file without concerning any organization.

If you work for an organization and you want to mention it, you'll be able to.

When will it be up?

This feature will be updated in the next mdCreator release.

Adding options to configuration file

A little configuration file option

Why this feature?

As you know, mdCreator allows users to call for the Tenor API to get Gifs Images.

The number of Gifs included in the created file is 2.

Feature Description

The next step is to allow users to ask for more Gifs by adding an option to the configuration file.

You could tho ask x Gifs for every README file you create, accordingly to the value in the configuration file.

When will it be up?

This feature will be available in the next update of mdCreator.

A little error concerning the -l option

Hi, here's 0Nom4D,

You can find below an error that can occur when using mdCreator:

• When using -l / --language, an error can occur if the string first letter isn't a uppercase letter.

This error will be fixed as soon as possible.

Auto update the "Prerequisites" section of the readme

Update the "Prerequisites" section with the language enter with the -l option, it would very convenient and more easy to use for lazy people like me

Camouflaging API Key

Before going further...

At commit 5f5920f, I tried to add a .env file to camouflage my API Key. Unfortunately, I was a fool and I didn't thought I would have to commit my .env file without document it.

At first, I wanted not to let users have their own API Key and to have a fully useful program ready to use.

I let security breaches open and nobody forced it. Unfortunately, I need to secure these breaches because 2 reasons:

• I'm a fool thinking nobody will try to shutdown the project
• That's not right to let security breaches open even for myself and not even professional to let these open

New Feature

From now on, mdCreator will ask for your Tenor API Key at first launch.

It will take your API key to work. A wiki page will be opened and a link in the project README will be added to this wiki page.

Template Option

Template CLI Option

mdCreator is getting a makeover. In the next weeks, I will try to rework the project a bit.

Features

mdCreator is a basic project. To be realistic, the project in this state is kinda useless... Why loosing time writing a JSON file while you can in the same amount of time, write the README entirely?

That is a big loss of time. So what can we do to improve our functionalities? What project we can inspire from in order to improve our project?

In the next release, mdCreator will have two ways to work:

• The project will still work with your custom configuration and the pro / student configurations. Don't worry it will still be working!

• Based on NPX way to work, a '--template' option will be added to the project. This option will get a README template you will choose. Then the project will create the README file and fill it with the template you chose.

This feature would increase the usability of the project and will avoid you useless jobs.