https://github.com/fdeaquino/professional-readme-generator
https://github.com/fdeaquino/professional-readme-generator
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/fdeaquino/professional-readme-generator
- Owner: fdeaquino
- License: mit
- Created: 2022-10-11T19:42:22.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-10-14T02:19:38.000Z (over 2 years ago)
- Last Synced: 2024-12-28T16:32:04.269Z (6 months ago)
- Language: JavaScript
- Size: 30.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# PROFESSIONAL README GENERATOR
## Description
README.md files play significant roles in Web Development because they are the "store front" of any project. Projects can benefit from high-quality README files by displaying key information to prospective contributers and intended users. This easy-to-use README Generator gives web developers some of their time back by producing a README file with essential information from user input. Using this tool gives Web Developers an opportunity to be more time efficient with their projects.
Building this README Generator gave me an opportunity to use my newfound npm inquirer and node.js skills. This was also an opportunity for me to use other skills like reading documentation and using Markdown syntax.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Credits](#credits)
- [License](#license)
## Installation
To install, you will need to clone this GitHub repository. Then, using the terminal on your local machine you will need to run `npm install` in the root directory of the repo.
## Usage
Please follow [this video guide](https://drive.google.com/file/d/1pwkSOpcD6mh-EgKUcMg9w4O2X2fLjHYq/view?usp=sharing) for using the README Generator or follow the steps below.
1. Open the terminal in your local machine
1. Navigate to the root directory of this project
1. To run the program, type `node index` and hit enter
1. Answer the question prompts as they appear in the terminal
- If a question does not apply to your project, please type `N/A`
1. After all questions have been answered you will see:
- Your answers populated in the terminal
- A newly created README file in the develop folder containing your responses about your project. (Feel free to use the `open preview` feature in your code editor to view the file)
## Credits
While creating this project, I used documentation as well as parts of a video tutorial as a guide linked below. Additionally, I used my previous experience building my portfolio-generator project from my bootcamp.
[node.js documentation](https://nodejs.org/dist/latest-v12.x/docs/api/fs.html)
[npm inquirer Documentation](https://www.npmjs.com/package/inquirer/v/8.2.4)
[Video Tutorial](https://www.youtube.com/watch?v=QFV7jzu8mKw&t=927s)
## License
[MIT](https://spdx.org/licenses/MIT.html)