Skip to content

A repository to hold a code for a professional README generator

License

Notifications You must be signed in to change notification settings

maijako/readme-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

29 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Professional README Generator

License: MIT

Description

This is a code for a command-line application that dynamically generates a professional README.md file from a user's input using the Inquirer package. It prompts user to input details about their project, and then dynamically generates a professional README file that features:

  • Project title
  • Project description
  • License badge and link
  • A hyperlinked table of contents
  • Usage and installation instructions
  • Testing and contributing instructions
  • Information and contact details of the developer

It can be run on any machine that has git/bash installed and requires minimal coding skills to operate.

Installation

To access the application, clone this code to your local repository. In your local repository, open the index.js file in your terminal.

Usage

Once you have accessed the index.js file of this code in your terminal, the application can be invoked by using the following command:

```bash
node index.js
```

Answer the prompts in the terminal, inputting your project title, description and details as prompted. At the end of the questions, the 'generatedREADME.md' file will be dynamically created in the same local repository. The generated file and be renamed and moved as appropriate.

Credits

The source code and the original asset files were provided by Trilogy Education as part of the Front End Web Development bootcamp sponsored by the Skills For Life program.

Licence

This code uses the MIT license.

About

A repository to hold a code for a professional README generator

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published