README generator
built using Node.js.
README Lab is a back-end application that generates a professional README.md file for your GitHub project. Writing one from scratch can be frustrating and confusing, so use this tool to generate the perfect document!
I've noticed how much time we developers spend creating a quality README.md file, or when we don't have the time to do this well, then it's often overlooked or treated as an afterthought. That's why I created this package, which will save us time and allow us to spend more time on the project itself. It will also ensure that every app has a professional README.md — something we all need!
During this process, I learned how crucial the file is to the application and what other items could be added to make it easier for users to understand and use effectively. Even the most elegantly designed application is useless if no one knows how to use it.
Click <> code - the green button. After clicking, in the local tab, copy the SSH key. Open the terminal in your Macbook or git bash, if you have Windows/Linux, and type:
git clone [paste ssh key]I would recommend downloading Visual Studio Code to edit the code locally. If you need more information on how to clone a repository, click here!
This package requires you to have Node.js, npm and Inquirer installed on your machine. You can install npm by running the code below on your terminal:
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.3/install.sh | bashOpen the project in VS Code and make sure you are in the directory of this application before installing Inquirer. To install it, type the command below on your terminal:
npm install --save inquirer@^8.2.5Note: Be sure to download this version, because newer versions no longer use the commonjs syntax require('inquirer').
The following images shows the two styles that you can create your README file:
Launch the application by entering the command below on your terminal:
node index.jsOnce the application is launched, a series of questions will appear so that the user can enter the necessary information to build the file.
A new README file will then be generated and saved in a different folder called dist. The content will vary depending on the user's inputs, but the available items are: Title of the project, Description, Table of Contents, Installation, Usage, License, Contributing, Tests, and Questions.
If you need more guidance on how to use README Lab, click here for the tutorial or scan the QR Code below:
Note: the README will be generated with some hints that you will need to change according to your project. After you finish, erase the notes.
For questions and support feel free to contact me via:
Want to report a bug, contribute some code, request a new feature, or improve the documentation? You can submit an issue and I will gladly welcome you as a contributor, but before submitting an issue, please search the issue tracker, as it may already exist!
Our Code of Conduct follows the same principles as the Contributor Covenant, version 2.1.
Enter the necessary inputs and check the terminal for errors.
Please refer to the LICENSE in the repo.