readme-cli-create

CLI for create README.md

👀 Comments

This CLI was made in a Linux environment (Zorin OS 16 Lite), from what I found in a Windows environment the CLI has problems working.

I don't know if this affects all Windows environments, as I've only tested it on one PC, but even so those who can contribute would be of great help

⭐ Objectives of this repository / project:

This project aims to make my life a little easier when creating READMEs.md, I always prefer to use a pattern, without changing too much from project to project, so I decided to create a CLI for whenever I need to type just one command in the terminal and that generate me a README.md the way I want or with a good base of it already ready, perfect to be something fast and agile

🔬 Technologies / Tools / Programming languages ​​used:

• Node.js
• VS CODE
• Yarn

💻 Prerequisites:

• Install Node.js
• Install Yarn or npm

🚀 Installing / using the project:

You can install this project globally with NPM, so you can use it anywhere on your PC

npm i readme-cli-create

or

npm i readme-cli-create -g

Another way to use this CLI is to clone this project on your PC (in this case you have git installed on your machine)

git clone https://github.com/LuigiBelanda/readme-cli-create.git

After cloning the project, run this command inside the project directory

npm link

After following one of the steps to generate your README.md use this command in your terminal, it will generate the README.md in the folder where you are

readme-cli-create

To create the readme file anyway

readme-cli-create -y

🖼️ Templates

Models

📄 Versions

• 1.0.0 - 1.0.1 (Putting CLI in NPM, actual implementation of the idea)
• 1.0.2 (Added check if the README.md file already exists in the directory, Added the "-y" parameter to create the file in any situation)
• 1.0.3 - 1.0.4 (Fixing the check for the existence of README.md in the directory where the command was executed and updating the README.md)
• 1.0.5 (Separating the README.md template from the main part of the CLI)
• 1.0.6 (By creating a new parameter (readme templates), we can now choose between readme template 0 and 1 (initial stage of the idea), better commenting the code)
• 1.0.7 (Fixing some bugs, changing the idea of ​​how to store readme templates and showing better success and error messages to the user)
• 1.0.8 (Adding questions, changing the cli structure in general, removing the need for parameters (0 or 1))
• 1.0.9 (Add new readme template, changing some project structures, improving responses in terminal)

👨‍💻 Developed by:

Luigi Belanda