When creating an open source project on GitHub, it’s important to have a high-quality README for the app. This project allows one to quickly create a basic README file via the command line using node.js. This allows the project creator to devote more time to working on their project.
- Node.js
- Javascript ES6+
Below is an example of how you can download the project onto your own device:
- Clone the repository within a new terminal
git clone https://github.com/squrpe/README-Generator.git
You will need to download the suitable extensions to run the application in the command line.
- Install the node modules needed for the project within the terminal
npm install
Using node.js via the command line to prompt the main file, index.js to start running.
Below is an example of the program:
To access the newly written README file, open the README.md in the ./dist folder.
Base Code & Project Idea: The University of Adelaide Coding Bootcamp
Lara Grocke - grockelara@gmail.com
Project Link - https://github.com/squrpe/README-Generator
LinkedIn - https://www.linkedin.com/in/laragrocke001
Distributed under the MIT License. See LICENSE.txt for more information.