https://github.com/ndf-web-dev/readme-file-generator
Application dynamically creates a Readme.md file.
https://github.com/ndf-web-dev/readme-file-generator
css html inquirer javascript nodejs
Last synced: about 2 months ago
JSON representation
Application dynamically creates a Readme.md file.
- Host: GitHub
- URL: https://github.com/ndf-web-dev/readme-file-generator
- Owner: NDF-WEB-DEV
- Created: 2022-10-05T01:14:34.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-08T01:22:19.000Z (over 3 years ago)
- Last Synced: 2025-05-30T06:49:54.804Z (about 1 year ago)
- Topics: css, html, inquirer, javascript, nodejs
- Language: JavaScript
- Homepage: https://drive.google.com/file/d/1C4Ag0KKnlKTdfabw3wB5hxVxCB4ZvWz5/view
- Size: 1.05 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# README.md File Generator
### []
### Description
> #### This project was created to build a high quality professional README.md file when creating a new repository for ope-source projects in GitHub.
## Table of Contents
- [Project Name](#project_name)
- [How to install it](#installation)
- [Running Tests](#tests)
- [How to use](#usage)
- [Report issues](#issues)
- [Questions](#username)
- [How to make contributions](#contributions)
- [Credits](#credits)
- [License](#license)
### Project Name
> Readme.md Professional File Generator
### Installation
> npm install inquirer
### Tests
> node index.js
### Usage
> This repo can be cloned and used to have a professional README.md file generator available to save time when pushing projects. This repo contains the following: node_modules directory, utils directory, .gitignore file, index.js file, package-lock.json file, package.json file, and a README.md file.
[Application Image - Files Explained](./images/Project-explanation-01.png)
[Application Image - Accessing the Terminal](./images/Project-explanation-02.png)
[Application Image - Running the App](./images/Project-explanation-03.png)
[Application Image - Input/Output](./images/Project-explanation-04.png)
### Questions
Contact me with questions via [GitHub](https://github.com/NDF-WEB-DEV) or send an email to: nordleendefrias@gmail.com
### Report Issues
> Email me
### Contributions
> Anyone can contribute to the repo to enhance or correct and collaborate.
### Credits
> https://www.npmjs.com/package/inquirer/v/8.2.4#installation and https://nodejs.org/api/fs.html
### License
> (https://opensource.org/licenses/MIT)
### Link for Video
[Link to Screencastify video](https://drive.google.com/file/d/1C4Ag0KKnlKTdfabw3wB5hxVxCB4ZvWz5/view?usp=sharing)