This project was born mainly to satisfy my desire for knowledge and to simplify my workflow. Being a curious (and also lazy) developer I have always wondered how avoid to waste my working time to write README.md files who fits perfectly project by project and that's why I wrote a tool to help me simplify and speed up these processes.
- boxen
- chalk
- commander
- figlet
- handlebars
- immer
- inquirer
- js-yaml
- lodash
Before cloning the repo be sure you have installed:
Then:
- Choose a folder project in your system and switch in
cd [folder path] - Clone the repo in your folder path
git clone git+https://github.com/ibbatta/readme-generator.git
In order to install the project and all dependencies, enter in the project folder and run npm install
npm startnpm testTo keep the style of resources consistent, I decided to stick to some shared rules that have to be applied to every project using some editors plugins. Plese be sure to disable / remove any other js/jsx linters or custom configurations.
I have chosen to use
This
works including a specific .dotfile in the root directory and making sure your editor has the necessary plugin.
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature - Commit your changes:
git commit -am 'Add some feature' - Push to the branch:
git push origin my-new-feature - Submit a pull request
This is just a personal project created for study / demonstration purpose and to simplify my working life, it may or may not be a good fit for your project(s).
Please ⭐ this repository if you like it or this project helped you!
Feel free to open issues or submit pull-requests to help me improving my work.
Maurizio Battaghini
Copyright © 2020 Maurizio Battaghini.