ReadMe Generator Module 9
The project is a command-line driven application, that shall be utilized along side your web app development process. A readme file with standard template will be generated and saved.
INPUT LATER
A deployed version can be viewed here.
Contents
- About
- User Story
- Acceptance criteria
- Visuals
- Build
- Installation
- License
- Contributing
-
About
Download as required, clone the repository for later usage.
—
User Story
Watch a video linked here :
—
Acceptance Criteria
Paste acceptance criteria :
#### GIVEN a command-line application that accepts user input.WHEN I am prompted for information about my application repository.THEN a high-quality, professional README.md is generated with the title of my project and. sections entitled Description, Table of Contents, Installation, Usage, License,,Contributing, Tests, and Questions,WHEN I enter my project titleTHEN this is displayed as the title of the READMEWHEN I enter a description, installation instructions, usage information, contribution guidelines, and test instructions THEN this information is added to the sections of the README entitled Description, Installation, Usage, Contributing, and Tests WHEN I choose a license for my application from a list of options THEN a badge for that license is added near the top of the README and a notice is added tothe section of the README entitled License that explains which license the application iscovered under WHEN I enter my GitHub username THEN this is added to the section of the README entitled Questions, with a link to my GitHub profile WHEN I enter my email address THEN this is added to the section of the README entitled Questions, with instructions on how to reach me with additional questions WHEN I click on the links in the Table of Contents THEN I am taken to the corresponding section of the README.
Visuals:
—
Installation:
Run npm install, and ensure to change the parameters for the package “inquirer”: “^8.2.4”.
License
License used for this project - INPUT LATER
Contributing:
Steps :
No contribution from outside sources are allowed, acceptable to clone and create alternate versions of noted program.
Tests:
Test instructions to be implemented on a later iteration, conduct generateMDfile.js test. We will expect a series of answers to be stored.
—
- GitHub Username: BulkAcity
- GitHub Email: BG@bulkacity.com